gogol-resourcemanager-0.0.1: Google Cloud Resource Manager SDK.

Copyright(c) 2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.ResourceManager.Types

Contents

Description

 

Synopsis

Service Configuration

resourceManagerService :: Service Source

Default request referring to version v1beta1 of the Google Cloud Resource Manager API. This contains the host and root path used as a starting point for constructing service requests.

OAuth Scopes

cloudPlatformScope :: OAuthScope Source

View and manage your data across Google Cloud Platform services

ResourceId

data ResourceId Source

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 AppEngine app, a Compute Engine instance, Cloud SQL database, ...

See: resourceId smart constructor.

resourceId :: ResourceId Source

Creates a value of ResourceId with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

riId :: Lens' ResourceId (Maybe Text) Source

Required field for the type-specific id. This should correspond to the id used in the type-specific API's.

riType :: Lens' ResourceId (Maybe Text) Source

Required field representing the resource type this id is for. At present, the only valid type is "organization".

ListProjectsResponse

data ListProjectsResponse Source

A page of the response received from the [ListProjects][google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.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.

See: listProjectsResponse smart constructor.

listProjectsResponse :: ListProjectsResponse Source

Creates a value of ListProjectsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lprNextPageToken :: Lens' ListProjectsResponse (Maybe Text) Source

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. Note: pagination is not yet supported; the server will not set this field.

lprProjects :: Lens' ListProjectsResponse [Project] Source

The list of projects that matched the list filter. This list can be paginated.

GetIAMPolicyRequest

getIAMPolicyRequest :: GetIAMPolicyRequest Source

Creates a value of GetIAMPolicyRequest with the minimum fields required to make a request.

OrganizationOwner

data OrganizationOwner Source

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.

See: organizationOwner smart constructor.

organizationOwner :: OrganizationOwner Source

Creates a value of OrganizationOwner with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ooDirectoryCustomerId :: Lens' OrganizationOwner (Maybe Text) Source

The Google for Work customer id used in the Directory API.

Project

data Project Source

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

See: project smart constructor.

project :: Project Source

Creates a value of Project with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pParent :: Lens' Project (Maybe ResourceId) Source

An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.

pProjectNumber :: Lens' Project (Maybe Int64) Source

The number uniquely identifying the project. Example: 415104041262 Read-only.

pName :: Lens' Project (Maybe Text) Source

The user-assigned name of the project. It must be 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.

pLabels :: Lens' Project (Maybe ProjectLabels) Source

The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 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.

pProjectId :: Lens' Project (Maybe Text) Source

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.

pLifecycleState :: Lens' Project (Maybe Text) Source

The project lifecycle state. Read-only.

pCreateTime :: Lens' Project (Maybe Text) Source

Creation time. Read-only.

Empty

data Empty Source

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

See: empty smart constructor.

empty :: Empty Source

Creates a value of Empty with the minimum fields required to make a request.

SetIAMPolicyRequest

setIAMPolicyRequest :: SetIAMPolicyRequest Source

Creates a value of SetIAMPolicyRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

siprPolicy :: Lens' SetIAMPolicyRequest (Maybe Policy) Source

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 Cloud Platform services (such as Projects) might reject them.

TestIAMPermissionsRequest

testIAMPermissionsRequest :: TestIAMPermissionsRequest Source

Creates a value of TestIAMPermissionsRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tiprPermissions :: Lens' TestIAMPermissionsRequest [Text] Source

The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

TestIAMPermissionsResponse

testIAMPermissionsResponse :: TestIAMPermissionsResponse Source

Creates a value of TestIAMPermissionsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tiamprPermissions :: Lens' TestIAMPermissionsResponse [Text] Source

A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

Policy

data Policy Source

Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** ``` { "bindings": [ { "role": "roles/owner", "members": [ "user:mike'example.com", "group:admins'example.com", "domain:google.com", "serviceAccount:my-other-app'appspot.gserviceaccount.com"] }, { "role": "roles/viewer", "members": ["user:sean'example.com"] } ] } ``` For a description of IAM and its features, see the [IAM developer's guide][https://cloud.google.com/iam].

See: policy smart constructor.

policy :: Policy Source

Creates a value of Policy with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pEtag :: Lens' Policy (Maybe Word8) Source

Can be used to perform a read-modify-write.

pVersion :: Lens' Policy (Maybe Int32) Source

Version of the `Policy`. The default version is 0.

pBindings :: Lens' Policy [Binding] Source

Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.

ProjectLabels

data ProjectLabels Source

The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 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.

See: projectLabels smart constructor.

projectLabels Source

Creates a value of ProjectLabels with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Organization

data Organization Source

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

See: organization smart constructor.

organization :: Organization Source

Creates a value of Organization with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

oOwner :: Lens' Organization (Maybe OrganizationOwner) Source

The owner of this Organization. The owner should be specified upon creation. Once set, it cannot be changed. This field is required.

oDisplayName :: Lens' Organization (Maybe Text) Source

A friendly string to be used to refer to the Organization in the UI. This field is required.

oOrganizationId :: Lens' Organization (Maybe Text) Source

An immutable id for the Organization that is assigned on creation. This should be omitted when creating a new Organization. This field is read-only.

Binding

data Binding Source

Associates `members` with a `role`.

See: binding smart constructor.

binding :: Binding Source

Creates a value of Binding with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

bMembers :: Lens' Binding [Text] Source

Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following formats: * `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. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice'gmail.com` or `joe'example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app'appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins'example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.

bRole :: Lens' Binding (Maybe Text) Source

Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required

ListOrganizationsResponse

listOrganizationsResponse :: ListOrganizationsResponse Source

Creates a value of ListOrganizationsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lorNextPageToken :: Lens' ListOrganizationsResponse (Maybe Text) Source

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.

lorOrganizations :: Lens' ListOrganizationsResponse [Organization] Source

The list of Organizations that matched the list query, possibly paginated.