| Copyright | (c) 2015-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.Google.ResourceManager
Contents
- Service Configuration
- OAuth Scopes
- API Declaration
- Resources
- cloudresourcemanager.operations.get
- cloudresourcemanager.organizations.get
- cloudresourcemanager.organizations.getIamPolicy
- cloudresourcemanager.organizations.search
- cloudresourcemanager.organizations.setIamPolicy
- cloudresourcemanager.organizations.testIamPermissions
- cloudresourcemanager.projects.create
- cloudresourcemanager.projects.delete
- cloudresourcemanager.projects.get
- cloudresourcemanager.projects.getIamPolicy
- cloudresourcemanager.projects.list
- cloudresourcemanager.projects.setIamPolicy
- cloudresourcemanager.projects.testIamPermissions
- cloudresourcemanager.projects.undelete
- cloudresourcemanager.projects.update
- Types
- Status
- SearchOrganizationsRequest
- ResourceId
- ListProjectsResponse
- GetIAMPolicyRequest
- OrganizationOwner
- Project
- Operation
- Empty
- ProjectCreationStatus
- StatusDetailsItem
- FolderOperationError
- SetIAMPolicyRequest
- TestIAMPermissionsRequest
- SearchOrganizationsResponse
- TestIAMPermissionsResponse
- Policy
- ProjectLabels
- OperationMetadata
- FolderOperation
- Organization
- OperationResponse
- UndeleteProjectRequest
- Binding
Description
The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.
- resourceManagerService :: ServiceConfig
- cloudPlatformReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform.read-only"]
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- type ResourceManagerAPI = OrganizationsGetIAMPolicyResource :<|> (OrganizationsGetResource :<|> (OrganizationsSetIAMPolicyResource :<|> (OrganizationsTestIAMPermissionsResource :<|> (OrganizationsSearchResource :<|> (OperationsGetResource :<|> (ProjectsListResource :<|> (ProjectsUndeleteResource :<|> (ProjectsGetIAMPolicyResource :<|> (ProjectsGetResource :<|> (ProjectsCreateResource :<|> (ProjectsSetIAMPolicyResource :<|> (ProjectsTestIAMPermissionsResource :<|> (ProjectsDeleteResource :<|> ProjectsUpdateResource)))))))))))))
- module Network.Google.Resource.CloudResourceManager.Operations.Get
- module Network.Google.Resource.CloudResourceManager.Organizations.Get
- module Network.Google.Resource.CloudResourceManager.Organizations.GetIAMPolicy
- module Network.Google.Resource.CloudResourceManager.Organizations.Search
- module Network.Google.Resource.CloudResourceManager.Organizations.SetIAMPolicy
- module Network.Google.Resource.CloudResourceManager.Organizations.TestIAMPermissions
- module Network.Google.Resource.CloudResourceManager.Projects.Create
- module Network.Google.Resource.CloudResourceManager.Projects.Delete
- module Network.Google.Resource.CloudResourceManager.Projects.Get
- module Network.Google.Resource.CloudResourceManager.Projects.GetIAMPolicy
- module Network.Google.Resource.CloudResourceManager.Projects.List
- module Network.Google.Resource.CloudResourceManager.Projects.SetIAMPolicy
- module Network.Google.Resource.CloudResourceManager.Projects.TestIAMPermissions
- module Network.Google.Resource.CloudResourceManager.Projects.Undelete
- module Network.Google.Resource.CloudResourceManager.Projects.Update
- data Status
- status :: Status
- sDetails :: Lens' Status [StatusDetailsItem]
- sCode :: Lens' Status (Maybe Int32)
- sMessage :: Lens' Status (Maybe Text)
- data SearchOrganizationsRequest
- searchOrganizationsRequest :: SearchOrganizationsRequest
- sorFilter :: Lens' SearchOrganizationsRequest (Maybe Text)
- sorPageToken :: Lens' SearchOrganizationsRequest (Maybe Text)
- sorPageSize :: Lens' SearchOrganizationsRequest (Maybe Int32)
- data ResourceId
- resourceId :: ResourceId
- riId :: Lens' ResourceId (Maybe Text)
- riType :: Lens' ResourceId (Maybe Text)
- data ListProjectsResponse
- listProjectsResponse :: ListProjectsResponse
- lprNextPageToken :: Lens' ListProjectsResponse (Maybe Text)
- lprProjects :: Lens' ListProjectsResponse [Project]
- data GetIAMPolicyRequest
- getIAMPolicyRequest :: GetIAMPolicyRequest
- data OrganizationOwner
- organizationOwner :: OrganizationOwner
- ooDirectoryCustomerId :: Lens' OrganizationOwner (Maybe Text)
- data Project
- project :: Project
- pParent :: Lens' Project (Maybe ResourceId)
- pProjectNumber :: Lens' Project (Maybe Int64)
- pName :: Lens' Project (Maybe Text)
- pLabels :: Lens' Project (Maybe ProjectLabels)
- pProjectId :: Lens' Project (Maybe Text)
- pLifecycleState :: Lens' Project (Maybe Text)
- pCreateTime :: Lens' Project (Maybe Text)
- data Operation
- operation :: Operation
- oDone :: Lens' Operation (Maybe Bool)
- oError :: Lens' Operation (Maybe Status)
- oResponse :: Lens' Operation (Maybe OperationResponse)
- oName :: Lens' Operation (Maybe Text)
- oMetadata :: Lens' Operation (Maybe OperationMetadata)
- data Empty
- empty :: Empty
- data ProjectCreationStatus
- projectCreationStatus :: ProjectCreationStatus
- pcsGettable :: Lens' ProjectCreationStatus (Maybe Bool)
- pcsReady :: Lens' ProjectCreationStatus (Maybe Bool)
- pcsCreateTime :: Lens' ProjectCreationStatus (Maybe Text)
- data StatusDetailsItem
- statusDetailsItem :: HashMap Text JSONValue -> StatusDetailsItem
- sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue)
- data FolderOperationError
- folderOperationError :: FolderOperationError
- foeErrorMessageId :: Lens' FolderOperationError (Maybe Text)
- data SetIAMPolicyRequest
- setIAMPolicyRequest :: SetIAMPolicyRequest
- siprPolicy :: Lens' SetIAMPolicyRequest (Maybe Policy)
- data TestIAMPermissionsRequest
- testIAMPermissionsRequest :: TestIAMPermissionsRequest
- tiprPermissions :: Lens' TestIAMPermissionsRequest [Text]
- data SearchOrganizationsResponse
- searchOrganizationsResponse :: SearchOrganizationsResponse
- sorNextPageToken :: Lens' SearchOrganizationsResponse (Maybe Text)
- sorOrganizations :: Lens' SearchOrganizationsResponse [Organization]
- data TestIAMPermissionsResponse
- testIAMPermissionsResponse :: TestIAMPermissionsResponse
- tiamprPermissions :: Lens' TestIAMPermissionsResponse [Text]
- data Policy
- policy :: Policy
- pEtag :: Lens' Policy (Maybe ByteString)
- pVersion :: Lens' Policy (Maybe Int32)
- pBindings :: Lens' Policy [Binding]
- data ProjectLabels
- projectLabels :: HashMap Text Text -> ProjectLabels
- plAddtional :: Lens' ProjectLabels (HashMap Text Text)
- data OperationMetadata
- operationMetadata :: HashMap Text JSONValue -> OperationMetadata
- omAddtional :: Lens' OperationMetadata (HashMap Text JSONValue)
- data FolderOperation
- folderOperation :: FolderOperation
- foDestinationParent :: Lens' FolderOperation (Maybe Text)
- foDisplayName :: Lens' FolderOperation (Maybe Text)
- foOperationType :: Lens' FolderOperation (Maybe Text)
- foSourceParent :: Lens' FolderOperation (Maybe Text)
- data Organization
- organization :: Organization
- orgCreationTime :: Lens' Organization (Maybe Text)
- orgOwner :: Lens' Organization (Maybe OrganizationOwner)
- orgName :: Lens' Organization (Maybe Text)
- orgDisplayName :: Lens' Organization (Maybe Text)
- orgLifecycleState :: Lens' Organization (Maybe Text)
- data OperationResponse
- operationResponse :: HashMap Text JSONValue -> OperationResponse
- orAddtional :: Lens' OperationResponse (HashMap Text JSONValue)
- data UndeleteProjectRequest
- undeleteProjectRequest :: UndeleteProjectRequest
- data Binding
- binding :: Binding
- bMembers :: Lens' Binding [Text]
- bRole :: Lens' Binding (Maybe Text)
Service Configuration
resourceManagerService :: ServiceConfig Source #
Default request referring to version v1 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
cloudPlatformReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform.read-only"] Source #
View your data across Google Cloud Platform services
cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"] Source #
View and manage your data across Google Cloud Platform services
API Declaration
type ResourceManagerAPI = OrganizationsGetIAMPolicyResource :<|> (OrganizationsGetResource :<|> (OrganizationsSetIAMPolicyResource :<|> (OrganizationsTestIAMPermissionsResource :<|> (OrganizationsSearchResource :<|> (OperationsGetResource :<|> (ProjectsListResource :<|> (ProjectsUndeleteResource :<|> (ProjectsGetIAMPolicyResource :<|> (ProjectsGetResource :<|> (ProjectsCreateResource :<|> (ProjectsSetIAMPolicyResource :<|> (ProjectsTestIAMPermissionsResource :<|> (ProjectsDeleteResource :<|> ProjectsUpdateResource))))))))))))) Source #
Represents the entirety of the methods and resources available for the Google Cloud Resource Manager API service.
Resources
cloudresourcemanager.operations.get
cloudresourcemanager.organizations.get
cloudresourcemanager.organizations.getIamPolicy
cloudresourcemanager.organizations.search
cloudresourcemanager.organizations.setIamPolicy
cloudresourcemanager.organizations.testIamPermissions
cloudresourcemanager.projects.create
cloudresourcemanager.projects.delete
cloudresourcemanager.projects.get
cloudresourcemanager.projects.getIamPolicy
cloudresourcemanager.projects.list
cloudresourcemanager.projects.setIamPolicy
cloudresourcemanager.projects.testIamPermissions
cloudresourcemanager.projects.undelete
cloudresourcemanager.projects.update
Types
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. The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.
See: status smart constructor.
sDetails :: Lens' Status [StatusDetailsItem] Source #
A list of messages that carry the error details. There will be a common set of message types for APIs to use.
sCode :: Lens' Status (Maybe Int32) Source #
The status code, which should be an enum value of google.rpc.Code.
sMessage :: Lens' Status (Maybe Text) Source #
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.
SearchOrganizationsRequest
data SearchOrganizationsRequest Source #
The request sent to the `SearchOrganizations` method.
See: searchOrganizationsRequest smart constructor.
Instances
searchOrganizationsRequest :: SearchOrganizationsRequest Source #
Creates a value of SearchOrganizationsRequest with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sorFilter :: Lens' SearchOrganizationsRequest (Maybe Text) Source #
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 Google for Work domain, for example: |Filter|Description| |------|-----------| |owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.| |domain:google.com|Organizations corresponding to the domain `google.com`.| This field is optional.
sorPageToken :: Lens' SearchOrganizationsRequest (Maybe Text) Source #
A pagination token returned from a previous call to `SearchOrganizations` that indicates from where listing should continue. This field is optional.
sorPageSize :: Lens' SearchOrganizationsRequest (Maybe Int32) Source #
The maximum number of Organizations to return in the response. This field is optional.
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, a Cloud SQL database, and so on.
See: resourceId smart constructor.
Instances
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 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.
lprProjects :: Lens' ListProjectsResponse [Project] Source #
The list of Projects that matched the list filter. This list can be paginated.
GetIAMPolicyRequest
data GetIAMPolicyRequest Source #
Request message for `GetIamPolicy` method.
See: getIAMPolicyRequest smart constructor.
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
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.
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 display 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.
Operation
This resource represents a long-running operation that is the result of a network API call.
See: operation smart constructor.
oDone :: Lens' Operation (Maybe Bool) Source #
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.
oError :: Lens' Operation (Maybe Status) Source #
The error result of the operation in case of failure.
oResponse :: Lens' Operation (Maybe OperationResponse) Source #
The normal response of the operation in case of success. 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`.
oName :: Lens' Operation (Maybe Text) Source #
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 have the format of `operations/some/unique/name`.
oMetadata :: Lens' Operation (Maybe OperationMetadata) Source #
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.
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); } The JSON representation for `Empty` is empty JSON object `{}`.
See: empty smart constructor.
ProjectCreationStatus
data ProjectCreationStatus Source #
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.
See: projectCreationStatus smart constructor.
projectCreationStatus :: ProjectCreationStatus Source #
Creates a value of ProjectCreationStatus with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pcsGettable :: Lens' ProjectCreationStatus (Maybe Bool) Source #
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.
pcsReady :: Lens' ProjectCreationStatus (Maybe Bool) Source #
True if the project creation process is complete.
pcsCreateTime :: Lens' ProjectCreationStatus (Maybe Text) Source #
Creation time of the project creation workflow.
StatusDetailsItem
data StatusDetailsItem Source #
Arguments
| :: HashMap Text JSONValue | |
| -> StatusDetailsItem |
Creates a value of StatusDetailsItem with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
FolderOperationError
data FolderOperationError Source #
A classification of the Folder Operation error.
See: folderOperationError smart constructor.
folderOperationError :: FolderOperationError Source #
Creates a value of FolderOperationError with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
foeErrorMessageId :: Lens' FolderOperationError (Maybe Text) Source #
The type of operation error experienced.
SetIAMPolicyRequest
data SetIAMPolicyRequest Source #
Request message for `SetIamPolicy` method.
See: setIAMPolicyRequest smart constructor.
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
data TestIAMPermissionsRequest Source #
Request message for `TestIamPermissions` method.
See: testIAMPermissionsRequest smart constructor.
Instances
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. For more information see IAM Overview.
SearchOrganizationsResponse
data SearchOrganizationsResponse Source #
The response returned from the `SearchOrganizations` method.
See: searchOrganizationsResponse smart constructor.
Instances
searchOrganizationsResponse :: SearchOrganizationsResponse Source #
Creates a value of SearchOrganizationsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sorNextPageToken :: Lens' SearchOrganizationsResponse (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.
sorOrganizations :: Lens' SearchOrganizationsResponse [Organization] Source #
The list of Organizations that matched the search query, possibly paginated.
TestIAMPermissionsResponse
data TestIAMPermissionsResponse Source #
Response message for `TestIamPermissions` method.
See: testIAMPermissionsResponse smart constructor.
Instances
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
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.
See: policy smart constructor.
pEtag :: Lens' Policy (Maybe ByteString) Source #
`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. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
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.
Arguments
| :: HashMap Text Text | |
| -> ProjectLabels |
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:
OperationMetadata
data OperationMetadata Source #
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.
See: operationMetadata smart constructor.
Arguments
| :: HashMap Text JSONValue | |
| -> OperationMetadata |
Creates a value of OperationMetadata with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
omAddtional :: Lens' OperationMetadata (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
FolderOperation
data FolderOperation Source #
Metadata describing a long running folder operation
See: folderOperation smart constructor.
folderOperation :: FolderOperation Source #
Creates a value of FolderOperation with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
foDestinationParent :: Lens' FolderOperation (Maybe Text) Source #
The resource name of the folder or organization we are either creating the folder under or moving the folder to.
foDisplayName :: Lens' FolderOperation (Maybe Text) Source #
The display name of the folder.
foOperationType :: Lens' FolderOperation (Maybe Text) Source #
The type of this operation.
foSourceParent :: Lens' FolderOperation (Maybe Text) Source #
The resource name of the folder's parent. Only applicable when the operation_type is MOVE.
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.
Instances
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:
orgCreationTime :: Lens' Organization (Maybe Text) Source #
Timestamp when the Organization was created. Assigned by the server. 'OutputOnly
orgOwner :: Lens' Organization (Maybe OrganizationOwner) Source #
The owner of this Organization. The owner should be specified on creation. Once set, it cannot be changed. This field is required.
orgName :: Lens' Organization (Maybe Text) Source #
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".
orgDisplayName :: Lens' Organization (Maybe Text) Source #
A friendly string to be used to refer to the Organization in the UI. Assigned by the server, set to the firm name of the Google For Work customer that owns this organization. 'OutputOnly
orgLifecycleState :: Lens' Organization (Maybe Text) Source #
The organization's current lifecycle state. Assigned by the server. 'OutputOnly
OperationResponse
data OperationResponse Source #
The normal response of the operation in case of success. 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`.
See: operationResponse smart constructor.
Arguments
| :: HashMap Text JSONValue | |
| -> OperationResponse |
Creates a value of OperationResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
orAddtional :: Lens' OperationResponse (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
UndeleteProjectRequest
data UndeleteProjectRequest Source #
The request sent to the UndeleteProject method.
See: undeleteProjectRequest smart constructor.
undeleteProjectRequest :: UndeleteProjectRequest Source #
Creates a value of UndeleteProjectRequest with the minimum fields required to make a request.
Binding
Associates `members` with a `role`.
See: binding smart constructor.
bMembers :: Lens' Binding [Text] Source #
Specifies the identities requesting access for a Cloud Platform 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. * `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`.