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"
)
Ancestor: Identifying information for a single ancestor of a project.
type Ancestor struct {
// ResourceId: Resource id of the ancestor.
ResourceId *ResourceId `json:"resourceId,omitempty"`
// ForceSendFields is a list of field names (e.g. "ResourceId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ResourceId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Ancestor) MarshalJSON() ([]byte, error)
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 (s *AuditConfig) MarshalJSON() ([]byte, error)
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 (s *AuditLogConfig) MarshalJSON() ([]byte, error)
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 (s *Binding) MarshalJSON() ([]byte, error)
BooleanConstraint: A `Constraint` that is either enforced or not. For example a constraint `constraints/compute.disableSerialPortAccess`. If it is enforced on a VM instance, serial port connections will not be opened to that instance.
type BooleanConstraint struct {
}
BooleanPolicy: Used in `policy_type` to specify how `boolean_policy` will behave at this resource.
type BooleanPolicy struct {
// Enforced: If `true`, then the `Policy` is enforced. If `false`, then any
// configuration is acceptable. Suppose you have a `Constraint`
// `constraints/compute.disableSerialPortAccess` with `constraint_default` set
// to `ALLOW`. A `Policy` for that `Constraint` exhibits the following
// behavior: - If the `Policy` at this resource has enforced set to `false`,
// serial port connection attempts will be allowed. - If the `Policy` at this
// resource has enforced set to `true`, serial port connection attempts will be
// refused. - If the `Policy` at this resource is `RestoreDefault`, serial port
// connection attempts will be allowed. - If no `Policy` is set at this
// resource or anywhere higher in the resource hierarchy, serial port
// connection attempts will be allowed. - If no `Policy` is set at this
// resource, but one exists higher in the resource hierarchy, the behavior is
// as if the`Policy` were set at this resource. The following examples
// demonstrate the different possible layerings: Example 1 (nearest
// `Constraint` wins): `organizations/foo` has a `Policy` with: {enforced:
// false} `projects/bar` has no `Policy` set. The constraint at `projects/bar`
// and `organizations/foo` will not be enforced. Example 2 (enforcement gets
// replaced): `organizations/foo` has a `Policy` with: {enforced: false}
// `projects/bar` has a `Policy` with: {enforced: true} The constraint at
// `organizations/foo` is not enforced. The constraint at `projects/bar` is
// enforced. Example 3 (RestoreDefault): `organizations/foo` has a `Policy`
// with: {enforced: true} `projects/bar` has a `Policy` with: {RestoreDefault:
// {}} The constraint at `organizations/foo` is enforced. The constraint at
// `projects/bar` is not enforced, because `constraint_default` for the
// `Constraint` is `ALLOW`.
Enforced bool `json:"enforced,omitempty"`
// ForceSendFields is a list of field names (e.g. "Enforced") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Enforced") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *BooleanPolicy) MarshalJSON() ([]byte, error)
ClearOrgPolicyRequest: The request sent to the ClearOrgPolicy method.
type ClearOrgPolicyRequest struct {
// Constraint: Name of the `Constraint` of the `Policy` to clear.
Constraint string `json:"constraint,omitempty"`
// Etag: The current version, for concurrency control. Not sending an `etag`
// will cause the `Policy` to be cleared blindly.
Etag string `json:"etag,omitempty"`
// ForceSendFields is a list of field names (e.g. "Constraint") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Constraint") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ClearOrgPolicyRequest) MarshalJSON() ([]byte, error)
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 (s *CloudresourcemanagerGoogleCloudResourcemanagerV2alpha1FolderOperation) MarshalJSON() ([]byte, error)
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 (s *CloudresourcemanagerGoogleCloudResourcemanagerV2beta1FolderOperation) MarshalJSON() ([]byte, error)
Constraint: A `Constraint` describes a way in which a resource's configuration can be restricted. For example, it controls which cloud services can be activated across an organization, or whether a Compute Engine instance can have serial port connections established. `Constraints` can be configured by the organization's policy administrator to fit the needs of the organzation by setting Policies for `Constraints` at different locations in the organization's resource hierarchy. Policies are inherited down the resource hierarchy from higher levels, but can also be overridden. For details about the inheritance rules please read about Policies (/resource-manager/reference/rest/v1/Policy). `Constraints` have a default behavior determined by the `constraint_default` field, which is the enforcement behavior that is used in the absence of a `Policy` being defined or inherited for the resource in question.
type Constraint struct {
// BooleanConstraint: Defines this constraint as being a BooleanConstraint.
BooleanConstraint *BooleanConstraint `json:"booleanConstraint,omitempty"`
// ConstraintDefault: The evaluation behavior of this constraint in the absence
// of 'Policy'.
//
// Possible values:
// "CONSTRAINT_DEFAULT_UNSPECIFIED" - This is only used for distinguishing
// unset values and should never be used.
// "ALLOW" - Indicate that all values are allowed for list constraints.
// Indicate that enforcement is off for boolean constraints.
// "DENY" - Indicate that all values are denied for list constraints.
// Indicate that enforcement is on for boolean constraints.
ConstraintDefault string `json:"constraintDefault,omitempty"`
// Description: Detailed description of what this `Constraint` controls as well
// as how and where it is enforced. Mutable.
Description string `json:"description,omitempty"`
// DisplayName: The human readable name. Mutable.
DisplayName string `json:"displayName,omitempty"`
// ListConstraint: Defines this constraint as being a ListConstraint.
ListConstraint *ListConstraint `json:"listConstraint,omitempty"`
// Name: Immutable value, required to globally be unique. For example,
// `constraints/serviceuser.services`
Name string `json:"name,omitempty"`
// Version: Version of the `Constraint`. Default version is 0;
Version int64 `json:"version,omitempty"`
// ForceSendFields is a list of field names (e.g. "BooleanConstraint") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "BooleanConstraint") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Constraint) MarshalJSON() ([]byte, error)
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 (s *CreateFolderMetadata) MarshalJSON() ([]byte, error)
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 (s *CreateProjectMetadata) MarshalJSON() ([]byte, error)
CreateTagBindingMetadata: Runtime operation information for creating a TagValue.
type CreateTagBindingMetadata struct {
}
CreateTagKeyMetadata: Runtime operation information for creating a TagKey.
type CreateTagKeyMetadata struct {
}
CreateTagValueMetadata: Runtime operation information for creating a TagValue.
type CreateTagValueMetadata struct {
}
DeleteFolderMetadata: A status object which is used as the `metadata` field for the `Operation` returned by `DeleteFolder`.
type DeleteFolderMetadata struct {
}
DeleteOrganizationMetadata: A status object which is used as the `metadata` field for the operation returned by DeleteOrganization.
type DeleteOrganizationMetadata struct {
}
DeleteProjectMetadata: A status object which is used as the `metadata` field for the Operation returned by `DeleteProject`.
type DeleteProjectMetadata struct {
}
DeleteTagBindingMetadata: Runtime operation information for deleting a TagBinding.
type DeleteTagBindingMetadata struct {
}
DeleteTagKeyMetadata: Runtime operation information for deleting a TagKey.
type DeleteTagKeyMetadata struct {
}
DeleteTagValueMetadata: Runtime operation information for deleting a TagValue.
type DeleteTagValueMetadata struct {
}
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:"-"`
}
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 (s *Expr) MarshalJSON() ([]byte, error)
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 (s *FolderOperation) MarshalJSON() ([]byte, error)
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 (s *FolderOperationError) MarshalJSON() ([]byte, error)
type FoldersClearOrgPolicyCall struct {
// contains filtered or unexported fields
}
func (c *FoldersClearOrgPolicyCall) Context(ctx context.Context) *FoldersClearOrgPolicyCall
Context sets the context to be used in this call's Do method.
func (c *FoldersClearOrgPolicyCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "cloudresourcemanager.folders.clearOrgPolicy" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *FoldersClearOrgPolicyCall) Fields(s ...googleapi.Field) *FoldersClearOrgPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *FoldersClearOrgPolicyCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type FoldersGetEffectiveOrgPolicyCall struct {
// contains filtered or unexported fields
}
func (c *FoldersGetEffectiveOrgPolicyCall) Context(ctx context.Context) *FoldersGetEffectiveOrgPolicyCall
Context sets the context to be used in this call's Do method.
func (c *FoldersGetEffectiveOrgPolicyCall) Do(opts ...googleapi.CallOption) (*OrgPolicy, error)
Do executes the "cloudresourcemanager.folders.getEffectiveOrgPolicy" call. Any non-2xx status code is an error. Response headers are in either *OrgPolicy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *FoldersGetEffectiveOrgPolicyCall) Fields(s ...googleapi.Field) *FoldersGetEffectiveOrgPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *FoldersGetEffectiveOrgPolicyCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type FoldersGetOrgPolicyCall struct {
// contains filtered or unexported fields
}
func (c *FoldersGetOrgPolicyCall) Context(ctx context.Context) *FoldersGetOrgPolicyCall
Context sets the context to be used in this call's Do method.
func (c *FoldersGetOrgPolicyCall) Do(opts ...googleapi.CallOption) (*OrgPolicy, error)
Do executes the "cloudresourcemanager.folders.getOrgPolicy" call. Any non-2xx status code is an error. Response headers are in either *OrgPolicy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *FoldersGetOrgPolicyCall) Fields(s ...googleapi.Field) *FoldersGetOrgPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *FoldersGetOrgPolicyCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type FoldersListAvailableOrgPolicyConstraintsCall struct {
// contains filtered or unexported fields
}
func (c *FoldersListAvailableOrgPolicyConstraintsCall) Context(ctx context.Context) *FoldersListAvailableOrgPolicyConstraintsCall
Context sets the context to be used in this call's Do method.
func (c *FoldersListAvailableOrgPolicyConstraintsCall) Do(opts ...googleapi.CallOption) (*ListAvailableOrgPolicyConstraintsResponse, error)
Do executes the "cloudresourcemanager.folders.listAvailableOrgPolicyConstraints" call. Any non-2xx status code is an error. Response headers are in either *ListAvailableOrgPolicyConstraintsResponse.ServerResponse.Header or (if 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 (c *FoldersListAvailableOrgPolicyConstraintsCall) Fields(s ...googleapi.Field) *FoldersListAvailableOrgPolicyConstraintsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *FoldersListAvailableOrgPolicyConstraintsCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *FoldersListAvailableOrgPolicyConstraintsCall) Pages(ctx context.Context, f func(*ListAvailableOrgPolicyConstraintsResponse) 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 FoldersListOrgPoliciesCall struct {
// contains filtered or unexported fields
}
func (c *FoldersListOrgPoliciesCall) Context(ctx context.Context) *FoldersListOrgPoliciesCall
Context sets the context to be used in this call's Do method.
func (c *FoldersListOrgPoliciesCall) Do(opts ...googleapi.CallOption) (*ListOrgPoliciesResponse, error)
Do executes the "cloudresourcemanager.folders.listOrgPolicies" call. Any non-2xx status code is an error. Response headers are in either *ListOrgPoliciesResponse.ServerResponse.Header or (if a response 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 (c *FoldersListOrgPoliciesCall) Fields(s ...googleapi.Field) *FoldersListOrgPoliciesCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *FoldersListOrgPoliciesCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *FoldersListOrgPoliciesCall) Pages(ctx context.Context, f func(*ListOrgPoliciesResponse) 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 FoldersService struct {
// contains filtered or unexported fields
}
func NewFoldersService(s *Service) *FoldersService
func (r *FoldersService) ClearOrgPolicy(resource string, clearorgpolicyrequest *ClearOrgPolicyRequest) *FoldersClearOrgPolicyCall
ClearOrgPolicy: Clears a `Policy` from a resource.
- resource: Name of the resource for the `Policy` to clear.
func (r *FoldersService) GetEffectiveOrgPolicy(resource string, geteffectiveorgpolicyrequest *GetEffectiveOrgPolicyRequest) *FoldersGetEffectiveOrgPolicyCall
GetEffectiveOrgPolicy: Gets the effective `Policy` on a resource. This is the result of merging `Policies` in the resource hierarchy. The returned `Policy` will not have an `etag`set because it is a computed `Policy` across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded.
func (r *FoldersService) GetOrgPolicy(resource string, getorgpolicyrequest *GetOrgPolicyRequest) *FoldersGetOrgPolicyCall
GetOrgPolicy: Gets a `Policy` on a resource. If no `Policy` is set on the resource, a `Policy` is returned with default values including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The `etag` value can be used with `SetOrgPolicy()` to create or update a `Policy` during read-modify-write.
- resource: Name of the resource the `Policy` is set on.
func (r *FoldersService) ListAvailableOrgPolicyConstraints(resource string, listavailableorgpolicyconstraintsrequest *ListAvailableOrgPolicyConstraintsRequest) *FoldersListAvailableOrgPolicyConstraintsCall
ListAvailableOrgPolicyConstraints: Lists `Constraints` that could be applied on the specified resource.
- resource: Name of the resource to list `Constraints` for.
func (r *FoldersService) ListOrgPolicies(resource string, listorgpoliciesrequest *ListOrgPoliciesRequest) *FoldersListOrgPoliciesCall
ListOrgPolicies: Lists all the `Policies` set for a particular resource.
- resource: Name of the resource to list Policies for.
func (r *FoldersService) SetOrgPolicy(resource string, setorgpolicyrequest *SetOrgPolicyRequest) *FoldersSetOrgPolicyCall
SetOrgPolicy: Updates the specified `Policy` on the resource. Creates a new `Policy` for that `Constraint` on the resource if one does not exist. Not supplying an `etag` on the request `Policy` results in an unconditional write of the `Policy`.
- resource: Resource name of the resource to attach the `Policy`.
type FoldersSetOrgPolicyCall struct {
// contains filtered or unexported fields
}
func (c *FoldersSetOrgPolicyCall) Context(ctx context.Context) *FoldersSetOrgPolicyCall
Context sets the context to be used in this call's Do method.
func (c *FoldersSetOrgPolicyCall) Do(opts ...googleapi.CallOption) (*OrgPolicy, error)
Do executes the "cloudresourcemanager.folders.setOrgPolicy" call. Any non-2xx status code is an error. Response headers are in either *OrgPolicy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *FoldersSetOrgPolicyCall) Fields(s ...googleapi.Field) *FoldersSetOrgPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *FoldersSetOrgPolicyCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
GetAncestryRequest: The request sent to the GetAncestry method.
type GetAncestryRequest struct {
}
GetAncestryResponse: Response from the projects.getAncestry method.
type GetAncestryResponse struct {
// Ancestor: Ancestors are ordered from bottom to top of the resource
// hierarchy. The first ancestor is the project itself, followed by the
// project's parent, etc..
Ancestor []*Ancestor `json:"ancestor,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Ancestor") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Ancestor") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GetAncestryResponse) MarshalJSON() ([]byte, error)
GetEffectiveOrgPolicyRequest: The request sent to the GetEffectiveOrgPolicy method.
type GetEffectiveOrgPolicyRequest struct {
// Constraint: The name of the `Constraint` to compute the effective `Policy`.
Constraint string `json:"constraint,omitempty"`
// ForceSendFields is a list of field names (e.g. "Constraint") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Constraint") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GetEffectiveOrgPolicyRequest) MarshalJSON() ([]byte, error)
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 (s *GetIamPolicyRequest) MarshalJSON() ([]byte, error)
GetOrgPolicyRequest: The request sent to the GetOrgPolicy method.
type GetOrgPolicyRequest struct {
// Constraint: Name of the `Constraint` to get the `Policy`.
Constraint string `json:"constraint,omitempty"`
// ForceSendFields is a list of field names (e.g. "Constraint") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Constraint") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GetOrgPolicyRequest) MarshalJSON() ([]byte, error)
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 (s *GetPolicyOptions) MarshalJSON() ([]byte, error)
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 (s *Lien) MarshalJSON() ([]byte, error)
type LiensCreateCall struct {
// contains filtered or unexported fields
}
func (c *LiensCreateCall) Context(ctx context.Context) *LiensCreateCall
Context sets the context to be used in this call's Do method.
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 (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 (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 struct {
// contains filtered or unexported fields
}
func (c *LiensDeleteCall) Context(ctx context.Context) *LiensDeleteCall
Context sets the context to be used in this call's Do method.
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 (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 (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 struct {
// contains filtered or unexported fields
}
func (c *LiensGetCall) Context(ctx context.Context) *LiensGetCall
Context sets the context to be used in this call's Do method.
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 (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 (c *LiensGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
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 struct {
// contains filtered or unexported fields
}
func (c *LiensListCall) Context(ctx context.Context) *LiensListCall
Context sets the context to be used in this call's Do method.
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 (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 (c *LiensListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
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 (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 (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 (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 (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 struct {
// contains filtered or unexported fields
}
func NewLiensService(s *Service) *LiensService
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 (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 (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 (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`.
ListAvailableOrgPolicyConstraintsRequest: The request sent to the `ListAvailableOrgPolicyConstraints` method on the project, folder, or organization.
type ListAvailableOrgPolicyConstraintsRequest struct {
// PageSize: Size of the pages to be returned. This is currently unsupported
// and will be ignored. The server may at any point start using this field to
// limit page size.
PageSize int64 `json:"pageSize,omitempty"`
// PageToken: Page token used to retrieve the next page. This is currently
// unsupported and will be ignored. The server may at any point start using
// this field.
PageToken string `json:"pageToken,omitempty"`
// ForceSendFields is a list of field names (e.g. "PageSize") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "PageSize") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListAvailableOrgPolicyConstraintsRequest) MarshalJSON() ([]byte, error)
ListAvailableOrgPolicyConstraintsResponse: The response returned from the `ListAvailableOrgPolicyConstraints` method. Returns all `Constraints` that could be set at this level of the hierarchy (contrast with the response from `ListPolicies`, which returns all policies which are set).
type ListAvailableOrgPolicyConstraintsResponse struct {
// Constraints: The collection of constraints that are settable on the request
// resource.
Constraints []*Constraint `json:"constraints,omitempty"`
// NextPageToken: Page token used to retrieve the next page. This is currently
// not used.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Constraints") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Constraints") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListAvailableOrgPolicyConstraintsResponse) MarshalJSON() ([]byte, error)
ListConstraint: A `Constraint` that allows or disallows a list of string values, which are configured by an Organization's policy administrator with a `Policy`.
type ListConstraint struct {
// SuggestedValue: Optional. The Google Cloud Console will try to default to a
// configuration that matches the value specified in this `Constraint`.
SuggestedValue string `json:"suggestedValue,omitempty"`
// SupportsUnder: Indicates whether subtrees of Cloud Resource Manager resource
// hierarchy can be used in `Policy.allowed_values` and `Policy.denied_values`.
// For example, "under:folders/123" would match any resource under the
// 'folders/123' folder.
SupportsUnder bool `json:"supportsUnder,omitempty"`
// ForceSendFields is a list of field names (e.g. "SuggestedValue") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "SuggestedValue") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListConstraint) MarshalJSON() ([]byte, error)
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 (s *ListLiensResponse) MarshalJSON() ([]byte, error)
ListOrgPoliciesRequest: The request sent to the ListOrgPolicies method.
type ListOrgPoliciesRequest struct {
// PageSize: Size of the pages to be returned. This is currently unsupported
// and will be ignored. The server may at any point start using this field to
// limit page size.
PageSize int64 `json:"pageSize,omitempty"`
// PageToken: Page token used to retrieve the next page. This is currently
// unsupported and will be ignored. The server may at any point start using
// this field.
PageToken string `json:"pageToken,omitempty"`
// ForceSendFields is a list of field names (e.g. "PageSize") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "PageSize") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListOrgPoliciesRequest) MarshalJSON() ([]byte, error)
ListOrgPoliciesResponse: The response returned from the `ListOrgPolicies` method. It will be empty if no `Policies` are set on the resource.
type ListOrgPoliciesResponse struct {
// NextPageToken: Page token used to retrieve the next page. This is currently
// not used, but the server may at any point start supplying a valid token.
NextPageToken string `json:"nextPageToken,omitempty"`
// Policies: The `Policies` that are set on the resource. It will be empty if
// no `Policies` are set.
Policies []*OrgPolicy `json:"policies,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NextPageToken") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NextPageToken") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListOrgPoliciesResponse) MarshalJSON() ([]byte, error)
ListPolicy: Used in `policy_type` to specify how `list_policy` behaves at this resource. `ListPolicy` can define specific values and subtrees of Cloud Resource Manager resource hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed or denied by setting the `allowed_values` and `denied_values` fields. This is achieved by using the `under:` and optional `is:` prefixes. The `under:` prefix is used to denote resource subtree values. The `is:` prefix is used to denote specific values, and is required only if the value contains a ":". Values prefixed with "is:" are treated the same as values with no prefix. Ancestry subtrees must be in one of the following formats: - "projects/", e.g. "projects/tokyo-rain-123" - "folders/", e.g. "folders/1234" - "organizations/", e.g. "organizations/1234" The `supports_under` field of the associated `Constraint` defines whether ancestry prefixes can be used. You can set `allowed_values` and `denied_values` in the same `Policy` if `all_values` is `ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all values. If `all_values` is set to either `ALLOW` or `DENY`, `allowed_values` and `denied_values` must be unset.
type ListPolicy struct {
// AllValues: The policy all_values state.
//
// Possible values:
// "ALL_VALUES_UNSPECIFIED" - Indicates that allowed_values or denied_values
// must be set.
// "ALLOW" - A policy with this set allows all values.
// "DENY" - A policy with this set denies all values.
AllValues string `json:"allValues,omitempty"`
// AllowedValues: List of values allowed at this resource. Can only be set if
// `all_values` is set to `ALL_VALUES_UNSPECIFIED`.
AllowedValues []string `json:"allowedValues,omitempty"`
// DeniedValues: List of values denied at this resource. Can only be set if
// `all_values` is set to `ALL_VALUES_UNSPECIFIED`.
DeniedValues []string `json:"deniedValues,omitempty"`
// InheritFromParent: Determines the inheritance behavior for this `Policy`. By
// default, a `ListPolicy` set at a resource supersedes any `Policy` set
// anywhere up the resource hierarchy. However, if `inherit_from_parent` is set
// to `true`, then the values from the effective `Policy` of the parent
// resource are inherited, meaning the values set in this `Policy` are added to
// the values inherited up the hierarchy. Setting `Policy` hierarchies that
// inherit both allowed values and denied values isn't recommended in most
// circumstances to keep the configuration simple and understandable. However,
// it is possible to set a `Policy` with `allowed_values` set that inherits a
// `Policy` with `denied_values` set. In this case, the values that are allowed
// must be in `allowed_values` and not present in `denied_values`. For example,
// suppose you have a `Constraint` `constraints/serviceuser.services`, which
// has a `constraint_type` of `list_constraint`, and with `constraint_default`
// set to `ALLOW`. Suppose that at the Organization level, a `Policy` is
// applied that restricts the allowed API activations to {`E1`, `E2`}. Then, if
// a `Policy` is applied to a project below the Organization that has
// `inherit_from_parent` set to `false` and field all_values set to DENY, then
// an attempt to activate any API will be denied. The following examples
// demonstrate different possible layerings for `projects/bar` parented by
// `organizations/foo`: Example 1 (no inherited values): `organizations/foo`
// has a `Policy` with values: {allowed_values: "E1" allowed_values:"E2"}
// `projects/bar` has `inherit_from_parent` `false` and values:
// {allowed_values: "E3" allowed_values: "E4"} The accepted values at
// `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar`
// are `E3`, and `E4`. Example 2 (inherited values): `organizations/foo` has a
// `Policy` with values: {allowed_values: "E1" allowed_values:"E2"}
// `projects/bar` has a `Policy` with values: {value: "E3" value: "E4"
// inherit_from_parent: true} The accepted values at `organizations/foo` are
// `E1`, `E2`. The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and
// `E4`. Example 3 (inheriting both allowed and denied values):
// `organizations/foo` has a `Policy` with values: {allowed_values: "E1"
// allowed_values: "E2"} `projects/bar` has a `Policy` with: {denied_values:
// "E1"} The accepted values at `organizations/foo` are `E1`, `E2`. The value
// accepted at `projects/bar` is `E2`. Example 4 (RestoreDefault):
// `organizations/foo` has a `Policy` with values: {allowed_values: "E1"
// allowed_values:"E2"} `projects/bar` has a `Policy` with values:
// {RestoreDefault: {}} The accepted values at `organizations/foo` are `E1`,
// `E2`. The accepted values at `projects/bar` are either all or none depending
// on the value of `constraint_default` (if `ALLOW`, all; if `DENY`, none).
// Example 5 (no policy inherits parent policy): `organizations/foo` has no
// `Policy` set. `projects/bar` has no `Policy` set. The accepted values at
// both levels are either all or none depending on the value of
// `constraint_default` (if `ALLOW`, all; if `DENY`, none). Example 6
// (ListConstraint allowing all): `organizations/foo` has a `Policy` with
// values: {allowed_values: "E1" allowed_values: "E2"} `projects/bar` has a
// `Policy` with: {all: ALLOW} The accepted values at `organizations/foo` are
// `E1`, E2`. Any value is accepted at `projects/bar`. Example 7
// (ListConstraint allowing none): `organizations/foo` has a `Policy` with
// values: {allowed_values: "E1" allowed_values: "E2"} `projects/bar` has a
// `Policy` with: {all: DENY} The accepted values at `organizations/foo` are
// `E1`, E2`. No value is accepted at `projects/bar`. Example 10 (allowed and
// denied subtrees of Resource Manager hierarchy): Given the following resource
// hierarchy O1->{F1, F2}; F1->{P1}; F2->{P2, P3}, `organizations/foo` has a
// `Policy` with values: {allowed_values: "under:organizations/O1"}
// `projects/bar` has a `Policy` with: {allowed_values: "under:projects/P3"}
// {denied_values: "under:folders/F2"} The accepted values at
// `organizations/foo` are `organizations/O1`, `folders/F1`, `folders/F2`,
// `projects/P1`, `projects/P2`, `projects/P3`. The accepted values at
// `projects/bar` are `organizations/O1`, `folders/F1`, `projects/P1`.
InheritFromParent bool `json:"inheritFromParent,omitempty"`
// SuggestedValue: Optional. The Google Cloud Console will try to default to a
// configuration that matches the value specified in this `Policy`. If
// `suggested_value` is not set, it will inherit the value specified higher in
// the hierarchy, unless `inherit_from_parent` is `false`.
SuggestedValue string `json:"suggestedValue,omitempty"`
// ForceSendFields is a list of field names (e.g. "AllValues") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AllValues") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListPolicy) MarshalJSON() ([]byte, error)
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.
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 that matched the list filter. This list can
// be paginated.
Projects []*Project `json:"projects,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NextPageToken") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NextPageToken") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListProjectsResponse) MarshalJSON() ([]byte, error)
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 (s *MoveFolderMetadata) MarshalJSON() ([]byte, error)
MoveProjectMetadata: A status object which is used as the `metadata` field for the Operation returned by MoveProject.
type MoveProjectMetadata struct {
}
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 (s *Operation) MarshalJSON() ([]byte, error)
type OperationsGetCall struct {
// contains filtered or unexported fields
}
func (c *OperationsGetCall) Context(ctx context.Context) *OperationsGetCall
Context sets the context to be used in this call's Do method.
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 (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 (c *OperationsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
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 struct {
// contains filtered or unexported fields
}
func NewOperationsService(s *Service) *OperationsService
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.
OrgPolicy: Defines a Cloud Organization `Policy` which is used to specify `Constraints` for configurations of Cloud Platform resources.
type OrgPolicy struct {
// BooleanPolicy: For boolean `Constraints`, whether to enforce the
// `Constraint` or not.
BooleanPolicy *BooleanPolicy `json:"booleanPolicy,omitempty"`
// Constraint: The name of the `Constraint` the `Policy` is configuring, for
// example, `constraints/serviceuser.services`. A list of available constraints
// (/resource-manager/docs/organization-policy/org-policy-constraints) is
// available. Immutable after creation.
Constraint string `json:"constraint,omitempty"`
// Etag: An opaque tag indicating the current version of the `Policy`, used for
// concurrency control. When the `Policy` is returned from either a `GetPolicy`
// or a `ListOrgPolicy` request, this `etag` indicates the version of the
// current `Policy` to use when executing a read-modify-write loop. When the
// `Policy` is returned from a `GetEffectivePolicy` request, the `etag` will be
// unset. When the `Policy` is used in a `SetOrgPolicy` method, use the `etag`
// value that was returned from a `GetOrgPolicy` request as part of a
// read-modify-write loop for concurrency control. Not setting the `etag`in a
// `SetOrgPolicy` request will result in an unconditional write of the
// `Policy`.
Etag string `json:"etag,omitempty"`
// ListPolicy: List of values either allowed or disallowed.
ListPolicy *ListPolicy `json:"listPolicy,omitempty"`
// RestoreDefault: Restores the default behavior of the constraint; independent
// of `Constraint` type.
RestoreDefault *RestoreDefault `json:"restoreDefault,omitempty"`
// UpdateTime: The time stamp the `Policy` was previously updated. This is set
// by the server, not specified by the caller, and represents the last time a
// call to `SetOrgPolicy` was made for that `Policy`. Any value set by the
// client will be ignored.
UpdateTime string `json:"updateTime,omitempty"`
// Version: Version of the `Policy`. Default version is 0;
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. "BooleanPolicy") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "BooleanPolicy") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *OrgPolicy) MarshalJSON() ([]byte, error)
Organization: The root node in the resource hierarchy to which a particular entity's (e.g., company) resources belong.
type Organization struct {
// CreationTime: Timestamp when the Organization was created. Assigned by the
// server.
CreationTime string `json:"creationTime,omitempty"`
// DisplayName: A human-readable string that refers to the Organization in the
// Google Cloud console. This string is set by the server and cannot be
// changed. The string will be set to the primary domain (for example,
// "google.com") of the G Suite customer that owns the organization.
DisplayName string `json:"displayName,omitempty"`
// LifecycleState: The organization's current lifecycle state. Assigned by the
// server.
//
// Possible values:
// "LIFECYCLE_STATE_UNSPECIFIED" - Unspecified state. This is only useful for
// distinguishing unset values.
// "ACTIVE" - The normal and active state.
// "DELETE_REQUESTED" - The organization has been marked for deletion by the
// user.
LifecycleState string `json:"lifecycleState,omitempty"`
// Name: Output only. The resource name of the organization. This is the
// organization's relative path in the API. Its format is
// "organizations/[organization_id]". For example, "organizations/1234".
Name string `json:"name,omitempty"`
// Owner: The owner of this Organization. The owner should be specified on
// creation. Once set, it cannot be changed. This field is required.
Owner *OrganizationOwner `json:"owner,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "CreationTime") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CreationTime") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Organization) MarshalJSON() ([]byte, error)
OrganizationOwner: The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the `OrganizationOwner`. If the `OrganizationOwner` is deleted, the Organization and all its descendants will be deleted.
type OrganizationOwner struct {
// DirectoryCustomerId: The G Suite customer id used in the Directory API.
DirectoryCustomerId string `json:"directoryCustomerId,omitempty"`
// ForceSendFields is a list of field names (e.g. "DirectoryCustomerId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DirectoryCustomerId") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *OrganizationOwner) MarshalJSON() ([]byte, error)
type OrganizationsClearOrgPolicyCall struct {
// contains filtered or unexported fields
}
func (c *OrganizationsClearOrgPolicyCall) Context(ctx context.Context) *OrganizationsClearOrgPolicyCall
Context sets the context to be used in this call's Do method.
func (c *OrganizationsClearOrgPolicyCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "cloudresourcemanager.organizations.clearOrgPolicy" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *OrganizationsClearOrgPolicyCall) Fields(s ...googleapi.Field) *OrganizationsClearOrgPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *OrganizationsClearOrgPolicyCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type OrganizationsGetCall struct {
// contains filtered or unexported fields
}
func (c *OrganizationsGetCall) Context(ctx context.Context) *OrganizationsGetCall
Context sets the context to be used in this call's Do method.
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 (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 (c *OrganizationsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
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 OrganizationsGetEffectiveOrgPolicyCall struct {
// contains filtered or unexported fields
}
func (c *OrganizationsGetEffectiveOrgPolicyCall) Context(ctx context.Context) *OrganizationsGetEffectiveOrgPolicyCall
Context sets the context to be used in this call's Do method.
func (c *OrganizationsGetEffectiveOrgPolicyCall) Do(opts ...googleapi.CallOption) (*OrgPolicy, error)
Do executes the "cloudresourcemanager.organizations.getEffectiveOrgPolicy" call. Any non-2xx status code is an error. Response headers are in either *OrgPolicy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *OrganizationsGetEffectiveOrgPolicyCall) Fields(s ...googleapi.Field) *OrganizationsGetEffectiveOrgPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *OrganizationsGetEffectiveOrgPolicyCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type OrganizationsGetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (c *OrganizationsGetIamPolicyCall) Context(ctx context.Context) *OrganizationsGetIamPolicyCall
Context sets the context to be used in this call's Do method.
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 (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 (c *OrganizationsGetIamPolicyCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type OrganizationsGetOrgPolicyCall struct {
// contains filtered or unexported fields
}
func (c *OrganizationsGetOrgPolicyCall) Context(ctx context.Context) *OrganizationsGetOrgPolicyCall
Context sets the context to be used in this call's Do method.
func (c *OrganizationsGetOrgPolicyCall) Do(opts ...googleapi.CallOption) (*OrgPolicy, error)
Do executes the "cloudresourcemanager.organizations.getOrgPolicy" call. Any non-2xx status code is an error. Response headers are in either *OrgPolicy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *OrganizationsGetOrgPolicyCall) Fields(s ...googleapi.Field) *OrganizationsGetOrgPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *OrganizationsGetOrgPolicyCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type OrganizationsListAvailableOrgPolicyConstraintsCall struct {
// contains filtered or unexported fields
}
func (c *OrganizationsListAvailableOrgPolicyConstraintsCall) Context(ctx context.Context) *OrganizationsListAvailableOrgPolicyConstraintsCall
Context sets the context to be used in this call's Do method.
func (c *OrganizationsListAvailableOrgPolicyConstraintsCall) Do(opts ...googleapi.CallOption) (*ListAvailableOrgPolicyConstraintsResponse, error)
Do executes the "cloudresourcemanager.organizations.listAvailableOrgPolicyConstraints" call. Any non-2xx status code is an error. Response headers are in either *ListAvailableOrgPolicyConstraintsResponse.ServerResponse.Header or (if 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 (c *OrganizationsListAvailableOrgPolicyConstraintsCall) Fields(s ...googleapi.Field) *OrganizationsListAvailableOrgPolicyConstraintsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *OrganizationsListAvailableOrgPolicyConstraintsCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *OrganizationsListAvailableOrgPolicyConstraintsCall) Pages(ctx context.Context, f func(*ListAvailableOrgPolicyConstraintsResponse) 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 OrganizationsListOrgPoliciesCall struct {
// contains filtered or unexported fields
}
func (c *OrganizationsListOrgPoliciesCall) Context(ctx context.Context) *OrganizationsListOrgPoliciesCall
Context sets the context to be used in this call's Do method.
func (c *OrganizationsListOrgPoliciesCall) Do(opts ...googleapi.CallOption) (*ListOrgPoliciesResponse, error)
Do executes the "cloudresourcemanager.organizations.listOrgPolicies" call. Any non-2xx status code is an error. Response headers are in either *ListOrgPoliciesResponse.ServerResponse.Header or (if a response 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 (c *OrganizationsListOrgPoliciesCall) Fields(s ...googleapi.Field) *OrganizationsListOrgPoliciesCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *OrganizationsListOrgPoliciesCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *OrganizationsListOrgPoliciesCall) Pages(ctx context.Context, f func(*ListOrgPoliciesResponse) 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 OrganizationsSearchCall struct {
// contains filtered or unexported fields
}
func (c *OrganizationsSearchCall) Context(ctx context.Context) *OrganizationsSearchCall
Context sets the context to be used in this call's Do method.
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 (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 (c *OrganizationsSearchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
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.
type OrganizationsService struct {
// contains filtered or unexported fields
}
func NewOrganizationsService(s *Service) *OrganizationsService
func (r *OrganizationsService) ClearOrgPolicy(resource string, clearorgpolicyrequest *ClearOrgPolicyRequest) *OrganizationsClearOrgPolicyCall
ClearOrgPolicy: Clears a `Policy` from a resource.
- resource: Name of the resource for the `Policy` to clear.
func (r *OrganizationsService) Get(name string) *OrganizationsGetCall
Get: Fetches an Organization resource identified by the specified resource name.
func (r *OrganizationsService) GetEffectiveOrgPolicy(resource string, geteffectiveorgpolicyrequest *GetEffectiveOrgPolicyRequest) *OrganizationsGetEffectiveOrgPolicyCall
GetEffectiveOrgPolicy: Gets the effective `Policy` on a resource. This is the result of merging `Policies` in the resource hierarchy. The returned `Policy` will not have an `etag`set because it is a computed `Policy` across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded.
func (r *OrganizationsService) GetIamPolicy(resource string, getiampolicyrequest *GetIamPolicyRequest) *OrganizationsGetIamPolicyCall
GetIamPolicy: Gets the access control policy for an Organization resource. May be empty if no such policy or resource exists. The `resource` field should be the organization's resource name, e.g. "organizations/123". Authorization requires the Google IAM permission `resourcemanager.organizations.getIamPolicy` on the specified organization
func (r *OrganizationsService) GetOrgPolicy(resource string, getorgpolicyrequest *GetOrgPolicyRequest) *OrganizationsGetOrgPolicyCall
GetOrgPolicy: Gets a `Policy` on a resource. If no `Policy` is set on the resource, a `Policy` is returned with default values including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The `etag` value can be used with `SetOrgPolicy()` to create or update a `Policy` during read-modify-write.
- resource: Name of the resource the `Policy` is set on.
func (r *OrganizationsService) ListAvailableOrgPolicyConstraints(resource string, listavailableorgpolicyconstraintsrequest *ListAvailableOrgPolicyConstraintsRequest) *OrganizationsListAvailableOrgPolicyConstraintsCall
ListAvailableOrgPolicyConstraints: Lists `Constraints` that could be applied on the specified resource.
- resource: Name of the resource to list `Constraints` for.
func (r *OrganizationsService) ListOrgPolicies(resource string, listorgpoliciesrequest *ListOrgPoliciesRequest) *OrganizationsListOrgPoliciesCall
ListOrgPolicies: Lists all the `Policies` set for a particular resource.
- resource: Name of the resource to list Policies for.
func (r *OrganizationsService) Search(searchorganizationsrequest *SearchOrganizationsRequest) *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. Search will only return organizations on which the user has the permission `resourcemanager.organizations.get` or has super admin privileges.
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, e.g. "organizations/123". Authorization requires the Google IAM permission `resourcemanager.organizations.setIamPolicy` on the specified organization
func (r *OrganizationsService) SetOrgPolicy(resource string, setorgpolicyrequest *SetOrgPolicyRequest) *OrganizationsSetOrgPolicyCall
SetOrgPolicy: Updates the specified `Policy` on the resource. Creates a new `Policy` for that `Constraint` on the resource if one does not exist. Not supplying an `etag` on the request `Policy` results in an unconditional write of the `Policy`.
- resource: Resource name of the resource to attach the `Policy`.
func (r *OrganizationsService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *OrganizationsTestIamPermissionsCall
TestIamPermissions: Returns permissions that a caller has on the specified Organization. The `resource` field should be the organization's resource name, e.g. "organizations/123". There are no permissions required for making this API call.
type OrganizationsSetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (c *OrganizationsSetIamPolicyCall) Context(ctx context.Context) *OrganizationsSetIamPolicyCall
Context sets the context to be used in this call's Do method.
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 (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 (c *OrganizationsSetIamPolicyCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type OrganizationsSetOrgPolicyCall struct {
// contains filtered or unexported fields
}
func (c *OrganizationsSetOrgPolicyCall) Context(ctx context.Context) *OrganizationsSetOrgPolicyCall
Context sets the context to be used in this call's Do method.
func (c *OrganizationsSetOrgPolicyCall) Do(opts ...googleapi.CallOption) (*OrgPolicy, error)
Do executes the "cloudresourcemanager.organizations.setOrgPolicy" call. Any non-2xx status code is an error. Response headers are in either *OrgPolicy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *OrganizationsSetOrgPolicyCall) Fields(s ...googleapi.Field) *OrganizationsSetOrgPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *OrganizationsSetOrgPolicyCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type OrganizationsTestIamPermissionsCall struct {
// contains filtered or unexported fields
}
func (c *OrganizationsTestIamPermissionsCall) Context(ctx context.Context) *OrganizationsTestIamPermissionsCall
Context sets the context to be used in this call's Do method.
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 (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 (c *OrganizationsTestIamPermissionsCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
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 (s *Policy) MarshalJSON() ([]byte, error)
Project: A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources.
type Project struct {
// CreateTime: Creation time. Read-only.
CreateTime string `json:"createTime,omitempty"`
// Labels: The labels associated with this Project. Label keys must be between
// 1 and 63 characters long and must conform to the following regular
// expression: a-z{0,62}. Label values must be between 0 and 63 characters long
// and must conform to the regular expression [a-z0-9_-]{0,63}. A label value
// can be empty. No more than 256 labels can be associated with a given
// resource. Clients should store labels in a representation such as JSON that
// does not depend on specific characters being disallowed. Example:
// "environment" : "dev" Read-write.
Labels map[string]string `json:"labels,omitempty"`
// LifecycleState: The Project lifecycle state. Read-only.
//
// Possible values:
// "LIFECYCLE_STATE_UNSPECIFIED" - Unspecified state. This is only
// used/useful for distinguishing unset values.
// "ACTIVE" - The normal and active state.
// "DELETE_REQUESTED" - The project has been marked for deletion by the user
// (by invoking DeleteProject) or by the system (Google Cloud Platform). This
// can generally be reversed by invoking UndeleteProject.
// "DELETE_IN_PROGRESS" - This lifecycle state is no longer used and not
// returned by the API.
LifecycleState string `json:"lifecycleState,omitempty"`
// Name: The optional user-assigned display name of the Project. When present
// it must be between 4 to 30 characters. Allowed characters are: lowercase and
// uppercase letters, numbers, hyphen, single-quote, double-quote, space, and
// exclamation point. Example: `My Project` Read-write.
Name string `json:"name,omitempty"`
// Parent: An optional reference to a parent Resource. Supported parent types
// include "organization" and "folder". Once set, the parent cannot be cleared.
// The `parent` can be set on creation or using the `UpdateProject` method; the
// end user must have the `resourcemanager.projects.create` permission on the
// parent.
Parent *ResourceId `json:"parent,omitempty"`
// ProjectId: The unique, user-assigned ID of the Project. It must be 6 to 30
// lowercase letters, digits, or hyphens. It must start with a letter. Trailing
// hyphens are prohibited. Example: `tokyo-rain-123` Read-only after creation.
ProjectId string `json:"projectId,omitempty"`
// ProjectNumber: The number uniquely identifying the project. Example:
// `415104041262` Read-only.
ProjectNumber int64 `json:"projectNumber,omitempty,string"`
// Tags: Optional. Input only. Immutable. Tag keys/values directly bound to
// this project. Each item in the map must be expressed as " : ". For example:
// "123/environment" : "production", "123/costCenter" : "marketing" Note:
// Currently this field is in Preview.
Tags map[string]string `json:"tags,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "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 (s *Project) MarshalJSON() ([]byte, error)
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 (s *ProjectCreationStatus) MarshalJSON() ([]byte, error)
type ProjectsClearOrgPolicyCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsClearOrgPolicyCall) Context(ctx context.Context) *ProjectsClearOrgPolicyCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsClearOrgPolicyCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "cloudresourcemanager.projects.clearOrgPolicy" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsClearOrgPolicyCall) Fields(s ...googleapi.Field) *ProjectsClearOrgPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsClearOrgPolicyCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsCreateCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsCreateCall) Context(ctx context.Context) *ProjectsCreateCall
Context sets the context to be used in this call's Do method.
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 (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 (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 struct {
// contains filtered or unexported fields
}
func (c *ProjectsDeleteCall) Context(ctx context.Context) *ProjectsDeleteCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "cloudresourcemanager.projects.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
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 (c *ProjectsDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsGetAncestryCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsGetAncestryCall) Context(ctx context.Context) *ProjectsGetAncestryCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsGetAncestryCall) Do(opts ...googleapi.CallOption) (*GetAncestryResponse, error)
Do executes the "cloudresourcemanager.projects.getAncestry" call. Any non-2xx status code is an error. Response headers are in either *GetAncestryResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsGetAncestryCall) Fields(s ...googleapi.Field) *ProjectsGetAncestryCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsGetAncestryCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsGetCall) Context(ctx context.Context) *ProjectsGetCall
Context sets the context to be used in this call's Do method.
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 (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 (c *ProjectsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
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 ProjectsGetEffectiveOrgPolicyCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsGetEffectiveOrgPolicyCall) Context(ctx context.Context) *ProjectsGetEffectiveOrgPolicyCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsGetEffectiveOrgPolicyCall) Do(opts ...googleapi.CallOption) (*OrgPolicy, error)
Do executes the "cloudresourcemanager.projects.getEffectiveOrgPolicy" call. Any non-2xx status code is an error. Response headers are in either *OrgPolicy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsGetEffectiveOrgPolicyCall) Fields(s ...googleapi.Field) *ProjectsGetEffectiveOrgPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsGetEffectiveOrgPolicyCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsGetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsGetIamPolicyCall) Context(ctx context.Context) *ProjectsGetIamPolicyCall
Context sets the context to be used in this call's Do method.
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 (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 (c *ProjectsGetIamPolicyCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsGetOrgPolicyCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsGetOrgPolicyCall) Context(ctx context.Context) *ProjectsGetOrgPolicyCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsGetOrgPolicyCall) Do(opts ...googleapi.CallOption) (*OrgPolicy, error)
Do executes the "cloudresourcemanager.projects.getOrgPolicy" call. Any non-2xx status code is an error. Response headers are in either *OrgPolicy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsGetOrgPolicyCall) Fields(s ...googleapi.Field) *ProjectsGetOrgPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsGetOrgPolicyCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsListAvailableOrgPolicyConstraintsCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsListAvailableOrgPolicyConstraintsCall) Context(ctx context.Context) *ProjectsListAvailableOrgPolicyConstraintsCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsListAvailableOrgPolicyConstraintsCall) Do(opts ...googleapi.CallOption) (*ListAvailableOrgPolicyConstraintsResponse, error)
Do executes the "cloudresourcemanager.projects.listAvailableOrgPolicyConstraints" call. Any non-2xx status code is an error. Response headers are in either *ListAvailableOrgPolicyConstraintsResponse.ServerResponse.Header or (if 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 (c *ProjectsListAvailableOrgPolicyConstraintsCall) Fields(s ...googleapi.Field) *ProjectsListAvailableOrgPolicyConstraintsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsListAvailableOrgPolicyConstraintsCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsListAvailableOrgPolicyConstraintsCall) Pages(ctx context.Context, f func(*ListAvailableOrgPolicyConstraintsResponse) 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 ProjectsListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsListCall) Context(ctx context.Context) *ProjectsListCall
Context sets the context to be used in this call's Do method.
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 (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 (c *ProjectsListCall) Filter(filter string) *ProjectsListCall
Filter sets the optional parameter "filter": An expression for filtering the results of the request. Filter rules are case insensitive. If multiple fields are included in a filter query, the query will return results that match any of the fields. Some eligible fields for filtering are: + `name` + `id` + `labels.` (where *key* is the name of a label) + `parent.type` + `parent.id` + `lifecycleState` Some examples of filter queries: | Query | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with "how". | | name:Howl | 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`. | | lifecycleState:DELETE_REQUESTED | Only show projects that are pending deletion.| If no filter is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission. NOTE: To perform a by-parent query (eg., what projects are directly in a Folder), the caller must have the `resourcemanager.projects.list` permission on the parent and the filter must contain both a `parent.type` and a `parent.id` restriction (example: "parent.type:folder parent.id:123"). In this case an alternate search index is used which provides more consistent results.
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 (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 (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 (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 (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.
type ProjectsListOrgPoliciesCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsListOrgPoliciesCall) Context(ctx context.Context) *ProjectsListOrgPoliciesCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsListOrgPoliciesCall) Do(opts ...googleapi.CallOption) (*ListOrgPoliciesResponse, error)
Do executes the "cloudresourcemanager.projects.listOrgPolicies" call. Any non-2xx status code is an error. Response headers are in either *ListOrgPoliciesResponse.ServerResponse.Header or (if a response 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 (c *ProjectsListOrgPoliciesCall) Fields(s ...googleapi.Field) *ProjectsListOrgPoliciesCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsListOrgPoliciesCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsListOrgPoliciesCall) Pages(ctx context.Context, f func(*ListOrgPoliciesResponse) 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 ProjectsService struct {
// contains filtered or unexported fields
}
func NewProjectsService(s *Service) *ProjectsService
func (r *ProjectsService) ClearOrgPolicy(resource string, clearorgpolicyrequest *ClearOrgPolicyRequest) *ProjectsClearOrgPolicyCall
ClearOrgPolicy: Clears a `Policy` from a resource.
- resource: Name of the resource for the `Policy` to clear.
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. Authorization requires the Google IAM permission `resourcemanager.projects.create` on the specified parent for the new project. The parent is identified by a specified ResourceId, which must include both an ID and a type, such as organization. This method does not associate the new project with a billing account. You can set or update the billing account associated with a project using the [`projects.updateBillingInfo`] (/billing/reference/rest/v1/projects/updateBillingInfo) method.
func (r *ProjectsService) Delete(projectId string) *ProjectsDeleteCall
Delete: Marks the Project identified by the specified `project_id` (for example, `my-project-123`) 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 and ListProjects methods. The caller must have delete permissions for this Project.
- projectId: The Project ID (for example, `foo-bar-123`).
func (r *ProjectsService) Get(projectId string) *ProjectsGetCall
Get: Retrieves the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this Project.
- projectId: The Project ID (for example, `my-project-123`).
func (r *ProjectsService) GetAncestry(projectId string, getancestryrequest *GetAncestryRequest) *ProjectsGetAncestryCall
GetAncestry: Gets a list of ancestors in the resource hierarchy for the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this Project.
- projectId: The Project ID (for example, `my-project-123`).
func (r *ProjectsService) GetEffectiveOrgPolicy(resource string, geteffectiveorgpolicyrequest *GetEffectiveOrgPolicyRequest) *ProjectsGetEffectiveOrgPolicyCall
GetEffectiveOrgPolicy: Gets the effective `Policy` on a resource. This is the result of merging `Policies` in the resource hierarchy. The returned `Policy` will not have an `etag`set because it is a computed `Policy` across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded.
func (r *ProjectsService) GetIamPolicy(resource string, getiampolicyrequest *GetIamPolicyRequest) *ProjectsGetIamPolicyCall
GetIamPolicy: Returns the IAM access control policy for the specified Project. Permission is denied if the policy or the resource does not exist. Authorization requires the Google IAM permission `resourcemanager.projects.getIamPolicy` on the project. For additional information about `resource` (e.g. my-project-id) structure and identification, see Resource Names (https://cloud.google.com/apis/design/resource_names).
func (r *ProjectsService) GetOrgPolicy(resource string, getorgpolicyrequest *GetOrgPolicyRequest) *ProjectsGetOrgPolicyCall
GetOrgPolicy: Gets a `Policy` on a resource. If no `Policy` is set on the resource, a `Policy` is returned with default values including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The `etag` value can be used with `SetOrgPolicy()` to create or update a `Policy` during read-modify-write.
- resource: Name of the resource the `Policy` is set on.
func (r *ProjectsService) List() *ProjectsListCall
List: Lists Projects that the caller has the `resourcemanager.projects.get` permission on and satisfy the specified filter. 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. NOTE: If the request filter contains a `parent.type` and `parent.id` and the caller has the `resourcemanager.projects.list` permission on the parent, the results will be drawn from an alternate index which provides more consistent results. In future versions of this API, this List method will be split into List and Search to properly capture the behavioral difference.
func (r *ProjectsService) ListAvailableOrgPolicyConstraints(resource string, listavailableorgpolicyconstraintsrequest *ListAvailableOrgPolicyConstraintsRequest) *ProjectsListAvailableOrgPolicyConstraintsCall
ListAvailableOrgPolicyConstraints: Lists `Constraints` that could be applied on the specified resource.
- resource: Name of the resource to list `Constraints` for.
func (r *ProjectsService) ListOrgPolicies(resource string, listorgpoliciesrequest *ListOrgPoliciesRequest) *ProjectsListOrgPoliciesCall
ListOrgPolicies: Lists all the `Policies` set for a particular resource.
- resource: Name of the resource to list Policies for.
func (r *ProjectsService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsSetIamPolicyCall
SetIamPolicy: Sets the IAM access control policy for the specified Project. CAUTION: This method will replace the existing policy, and cannot be used 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. For additional information about `resource` (e.g. my-project-id) structure and identification, see Resource Names (https://cloud.google.com/apis/design/resource_names). The 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 via 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. + You can only grant ownership of a project to a member by using the Google Cloud console. Inviting a member will deliver an invitation email that they must accept. An invitation email is not generated if you are granting a role other than owner, or if both the member you are inviting and the project are part of your organization. + 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. Authorization requires the Google IAM permission `resourcemanager.projects.setIamPolicy` on the project
func (r *ProjectsService) SetOrgPolicy(resource string, setorgpolicyrequest *SetOrgPolicyRequest) *ProjectsSetOrgPolicyCall
SetOrgPolicy: Updates the specified `Policy` on the resource. Creates a new `Policy` for that `Constraint` on the resource if one does not exist. Not supplying an `etag` on the request `Policy` results in an unconditional write of the `Policy`.
- resource: Resource name of the resource to attach the `Policy`.
func (r *ProjectsService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsTestIamPermissionsCall
TestIamPermissions: Returns permissions that a caller has on the specified Project. For additional information about `resource` (e.g. my-project-id) structure and identification, see Resource Names (https://cloud.google.com/apis/design/resource_names). There are no permissions required for making this API call.
func (r *ProjectsService) Undelete(projectId string, undeleteprojectrequest *UndeleteProjectRequest) *ProjectsUndeleteCall
Undelete: Restores the Project identified by the specified `project_id` (for example, `my-project-123`). 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 undelete permissions for this Project.
- projectId: The project ID (for example, `foo-bar-123`).
func (r *ProjectsService) Update(projectId string, project *Project) *ProjectsUpdateCall
Update: Updates the attributes of the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have modify permissions for this Project.
- projectId: The project ID (for example, `my-project-123`).
type ProjectsSetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSetIamPolicyCall) Context(ctx context.Context) *ProjectsSetIamPolicyCall
Context sets the context to be used in this call's Do method.
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 (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 (c *ProjectsSetIamPolicyCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsSetOrgPolicyCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSetOrgPolicyCall) Context(ctx context.Context) *ProjectsSetOrgPolicyCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSetOrgPolicyCall) Do(opts ...googleapi.CallOption) (*OrgPolicy, error)
Do executes the "cloudresourcemanager.projects.setOrgPolicy" call. Any non-2xx status code is an error. Response headers are in either *OrgPolicy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsSetOrgPolicyCall) Fields(s ...googleapi.Field) *ProjectsSetOrgPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsSetOrgPolicyCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsTestIamPermissionsCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsTestIamPermissionsCall) Context(ctx context.Context) *ProjectsTestIamPermissionsCall
Context sets the context to be used in this call's Do method.
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 (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 (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 struct {
// contains filtered or unexported fields
}
func (c *ProjectsUndeleteCall) Context(ctx context.Context) *ProjectsUndeleteCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsUndeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "cloudresourcemanager.projects.undelete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
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 (c *ProjectsUndeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsUpdateCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsUpdateCall) Context(ctx context.Context) *ProjectsUpdateCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsUpdateCall) Do(opts ...googleapi.CallOption) (*Project, error)
Do executes the "cloudresourcemanager.projects.update" call. Any non-2xx status code is an error. Response headers are in either *Project.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsUpdateCall) Fields(s ...googleapi.Field) *ProjectsUpdateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsUpdateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
ResourceId: A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an App Engine app, a Compute Engine instance, a Cloud SQL database, and so on.
type ResourceId struct {
// Id: The type-specific id. This should correspond to the id used in the
// type-specific API's.
Id string `json:"id,omitempty"`
// Type: The resource type this id is for. At present, the valid types are:
// "organization", "folder", and "project".
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "Id") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Id") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ResourceId) MarshalJSON() ([]byte, error)
RestoreDefault: Ignores policies set above this resource and restores the `constraint_default` enforcement behavior of the specific `Constraint` at this resource. Suppose that `constraint_default` is set to `ALLOW` for the `Constraint` `constraints/serviceuser.services`. Suppose that organization foo.com sets a `Policy` at their Organization resource node that restricts the allowed service activations to deny all service activations. They could then set a `Policy` with the `policy_type` `restore_default` on several experimental projects, restoring the `constraint_default` enforcement of the `Constraint` for only those projects, allowing those projects to have all services activated.
type RestoreDefault struct {
}
SearchOrganizationsRequest: The request sent to the `SearchOrganizations` method.
type SearchOrganizationsRequest struct {
// Filter: An optional query string used to filter the Organizations to return
// in the response. Filter rules are case-insensitive. Organizations may be
// filtered by `owner.directoryCustomerId` or by `domain`, where the domain is
// a G Suite domain, for example: * Filter
// `owner.directorycustomerid:123456789` returns Organization resources with
// `owner.directory_customer_id` equal to `123456789`. * Filter
// `domain:google.com` returns Organization resources corresponding to the
// domain `google.com`. This field is optional.
Filter string `json:"filter,omitempty"`
// PageSize: The maximum number of Organizations to return in the response. The
// server can return fewer organizations than requested. If unspecified, server
// picks an appropriate default.
PageSize int64 `json:"pageSize,omitempty"`
// PageToken: A pagination token returned from a previous call to
// `SearchOrganizations` that indicates from where listing should continue.
// This field is optional.
PageToken string `json:"pageToken,omitempty"`
// ForceSendFields is a list of field names (e.g. "Filter") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Filter") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SearchOrganizationsRequest) MarshalJSON() ([]byte, error)
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 (s *SearchOrganizationsResponse) MarshalJSON() ([]byte, error)
type Service struct {
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Folders *FoldersService
Liens *LiensService
Operations *OperationsService
Organizations *OrganizationsService
Projects *ProjectsService
// contains filtered or unexported fields
}
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(ctx context.Context, opts ...option.ClientOption) (*Service, error)
NewService creates a new Service.
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 (s *SetIamPolicyRequest) MarshalJSON() ([]byte, error)
SetOrgPolicyRequest: The request sent to the SetOrgPolicyRequest method.
type SetOrgPolicyRequest struct {
// Policy: `Policy` to set on the resource.
Policy *OrgPolicy `json:"policy,omitempty"`
// ForceSendFields is a list of field names (e.g. "Policy") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Policy") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SetOrgPolicyRequest) MarshalJSON() ([]byte, error)
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 (s *Status) MarshalJSON() ([]byte, error)
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 (s *TestIamPermissionsRequest) MarshalJSON() ([]byte, error)
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 (s *TestIamPermissionsResponse) MarshalJSON() ([]byte, error)
UndeleteFolderMetadata: A status object which is used as the `metadata` field for the `Operation` returned by `UndeleteFolder`.
type UndeleteFolderMetadata struct {
}
UndeleteOrganizationMetadata: A status object which is used as the `metadata` field for the Operation returned by UndeleteOrganization.
type UndeleteOrganizationMetadata struct {
}
UndeleteProjectMetadata: A status object which is used as the `metadata` field for the Operation returned by `UndeleteProject`.
type UndeleteProjectMetadata struct {
}
UndeleteProjectRequest: The request sent to the UndeleteProject method.
type UndeleteProjectRequest struct {
}
UpdateFolderMetadata: A status object which is used as the `metadata` field for the Operation returned by UpdateFolder.
type UpdateFolderMetadata struct {
}
UpdateProjectMetadata: A status object which is used as the `metadata` field for the Operation returned by UpdateProject.
type UpdateProjectMetadata struct {
}
UpdateTagKeyMetadata: Runtime operation information for updating a TagKey.
type UpdateTagKeyMetadata struct {
}
UpdateTagValueMetadata: Runtime operation information for updating a TagValue.
type UpdateTagValueMetadata struct {
}