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 |
- Service Configuration
- OAuth Scopes
- CounterOptions
- Empty
- ServiceAccountKey
- Rule
- CreateServiceAccountKeyRequest
- SetIAMPolicyRequest
- SignBlobRequest
- ListServiceAccountKeysResponse
- CloudAuditOptions
- DataAccessOptions
- ServiceAccount
- TestIAMPermissionsRequest
- TestIAMPermissionsResponse
- Policy
- Condition
- SignBlobResponse
- ListServiceAccountsResponse
- LogConfig
- CreateServiceAccountRequest
- Binding
- knowledgeGraphSearchService :: ServiceConfig
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- data CounterOptions
- counterOptions :: CounterOptions
- coField :: Lens' CounterOptions (Maybe Text)
- coMetric :: Lens' CounterOptions (Maybe Text)
- data Empty
- empty :: Empty
- data ServiceAccountKey
- serviceAccountKey :: ServiceAccountKey
- sakValidAfterTime :: Lens' ServiceAccountKey (Maybe Text)
- sakPrivateKeyData :: Lens' ServiceAccountKey (Maybe ByteString)
- sakName :: Lens' ServiceAccountKey (Maybe Text)
- sakPrivateKeyType :: Lens' ServiceAccountKey (Maybe Text)
- sakValidBeforeTime :: Lens' ServiceAccountKey (Maybe Text)
- data Rule
- rule :: Rule
- rAction :: Lens' Rule (Maybe Text)
- rIn :: Lens' Rule [Text]
- rNotIn :: Lens' Rule [Text]
- rConditions :: Lens' Rule [Condition]
- rPermissions :: Lens' Rule [Text]
- rLogConfig :: Lens' Rule [LogConfig]
- rDescription :: Lens' Rule (Maybe Text)
- data CreateServiceAccountKeyRequest
- createServiceAccountKeyRequest :: CreateServiceAccountKeyRequest
- csakrPrivateKeyType :: Lens' CreateServiceAccountKeyRequest (Maybe Text)
- data SetIAMPolicyRequest
- setIAMPolicyRequest :: SetIAMPolicyRequest
- siprPolicy :: Lens' SetIAMPolicyRequest (Maybe Policy)
- data SignBlobRequest
- signBlobRequest :: SignBlobRequest
- sbrBytesToSign :: Lens' SignBlobRequest (Maybe ByteString)
- data ListServiceAccountKeysResponse
- listServiceAccountKeysResponse :: ListServiceAccountKeysResponse
- lsakrKeys :: Lens' ListServiceAccountKeysResponse [ServiceAccountKey]
- data CloudAuditOptions
- cloudAuditOptions :: CloudAuditOptions
- data DataAccessOptions
- dataAccessOptions :: DataAccessOptions
- data ServiceAccount
- serviceAccount :: ServiceAccount
- saEmail :: Lens' ServiceAccount (Maybe Text)
- saEtag :: Lens' ServiceAccount (Maybe ByteString)
- saUniqueId :: Lens' ServiceAccount (Maybe Text)
- saName :: Lens' ServiceAccount (Maybe Text)
- saDisplayName :: Lens' ServiceAccount (Maybe Text)
- saProjectId :: Lens' ServiceAccount (Maybe Text)
- saOAuth2ClientId :: Lens' ServiceAccount (Maybe Text)
- data TestIAMPermissionsRequest
- testIAMPermissionsRequest :: TestIAMPermissionsRequest
- tiprPermissions :: Lens' TestIAMPermissionsRequest [Text]
- data TestIAMPermissionsResponse
- testIAMPermissionsResponse :: TestIAMPermissionsResponse
- tiamprPermissions :: Lens' TestIAMPermissionsResponse [Text]
- data Policy
- policy :: Policy
- pEtag :: Lens' Policy (Maybe ByteString)
- pRules :: Lens' Policy [Rule]
- pVersion :: Lens' Policy (Maybe Int32)
- pBindings :: Lens' Policy [Binding]
- data Condition
- condition :: Condition
- cOp :: Lens' Condition (Maybe Text)
- cIAM :: Lens' Condition (Maybe Text)
- cValues :: Lens' Condition [Text]
- cValue :: Lens' Condition (Maybe Text)
- cSys :: Lens' Condition (Maybe Text)
- cSvc :: Lens' Condition (Maybe Text)
- data SignBlobResponse
- signBlobResponse :: SignBlobResponse
- sbrSignature :: Lens' SignBlobResponse (Maybe ByteString)
- sbrKeyId :: Lens' SignBlobResponse (Maybe Text)
- data ListServiceAccountsResponse
- listServiceAccountsResponse :: ListServiceAccountsResponse
- lsarNextPageToken :: Lens' ListServiceAccountsResponse (Maybe Text)
- lsarAccounts :: Lens' ListServiceAccountsResponse [ServiceAccount]
- data LogConfig
- logConfig :: LogConfig
- lcCloudAudit :: Lens' LogConfig (Maybe CloudAuditOptions)
- lcDataAccess :: Lens' LogConfig (Maybe DataAccessOptions)
- lcCounter :: Lens' LogConfig (Maybe CounterOptions)
- data CreateServiceAccountRequest
- createServiceAccountRequest :: CreateServiceAccountRequest
- csarServiceAccount :: Lens' CreateServiceAccountRequest (Maybe ServiceAccount)
- csarAccountId :: Lens' CreateServiceAccountRequest (Maybe Text)
- data Binding
- binding :: Binding
- bMembers :: Lens' Binding [Text]
- bRole :: Lens' Binding (Maybe Text)
Service Configuration
knowledgeGraphSearchService :: ServiceConfig Source #
Default request referring to version v1
of the Google Identity and Access Management API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"] Source #
View and manage your data across Google Cloud Platform services
CounterOptions
data CounterOptions Source #
Options for counters
See: counterOptions
smart constructor.
counterOptions :: CounterOptions Source #
Creates a value of CounterOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
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.
ServiceAccountKey
data ServiceAccountKey Source #
Represents a service account key. A service account can have 0 or more key pairs. The private keys for these are not stored by Google. ServiceAccountKeys are immutable.
See: serviceAccountKey
smart constructor.
serviceAccountKey :: ServiceAccountKey Source #
Creates a value of ServiceAccountKey
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sakValidAfterTime :: Lens' ServiceAccountKey (Maybe Text) Source #
The key can be used after this timestamp.
sakPrivateKeyData :: Lens' ServiceAccountKey (Maybe ByteString) Source #
The key data.
sakName :: Lens' ServiceAccountKey (Maybe Text) Source #
The resource name of the service account key in the format "projects/{project}/serviceAccounts/{email}/keys/{key}".
sakPrivateKeyType :: Lens' ServiceAccountKey (Maybe Text) Source #
The type of the private key.
sakValidBeforeTime :: Lens' ServiceAccountKey (Maybe Text) Source #
The key can be used before this timestamp.
Rule
A rule to be applied in a Policy.
See: rule
smart constructor.
Creates a value of Rule
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rIn :: Lens' Rule [Text] Source #
The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
rNotIn :: Lens' Rule [Text] Source #
The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries. The format for in and not_in entries is the same as for members in a Binding (see google/iam/v1/policy.proto).
rPermissions :: Lens' Rule [Text] Source #
A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
rLogConfig :: Lens' Rule [LogConfig] Source #
The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
CreateServiceAccountKeyRequest
data CreateServiceAccountKeyRequest Source #
The service account key create request.
See: createServiceAccountKeyRequest
smart constructor.
createServiceAccountKeyRequest :: CreateServiceAccountKeyRequest Source #
Creates a value of CreateServiceAccountKeyRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
csakrPrivateKeyType :: Lens' CreateServiceAccountKeyRequest (Maybe Text) Source #
The type of the key requested. GOOGLE_CREDENTIALS is the default key type.
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.
SignBlobRequest
data SignBlobRequest Source #
The service account sign blob request.
See: signBlobRequest
smart constructor.
signBlobRequest :: SignBlobRequest Source #
Creates a value of SignBlobRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sbrBytesToSign :: Lens' SignBlobRequest (Maybe ByteString) Source #
The bytes to sign
ListServiceAccountKeysResponse
data ListServiceAccountKeysResponse Source #
The service account keys list response.
See: listServiceAccountKeysResponse
smart constructor.
listServiceAccountKeysResponse :: ListServiceAccountKeysResponse Source #
Creates a value of ListServiceAccountKeysResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lsakrKeys :: Lens' ListServiceAccountKeysResponse [ServiceAccountKey] Source #
The public keys for the service account.
CloudAuditOptions
data CloudAuditOptions Source #
Write a Cloud Audit log
See: cloudAuditOptions
smart constructor.
cloudAuditOptions :: CloudAuditOptions Source #
Creates a value of CloudAuditOptions
with the minimum fields required to make a request.
DataAccessOptions
data DataAccessOptions Source #
Write a Data Access (Gin) log
See: dataAccessOptions
smart constructor.
dataAccessOptions :: DataAccessOptions Source #
Creates a value of DataAccessOptions
with the minimum fields required to make a request.
ServiceAccount
data ServiceAccount Source #
A service account in the Identity and Access Management API. To create a service account, you specify the project_id and account_id for the account. The account_id is unique within the project, and used to generate the service account email address and a stable unique id. All other methods can identify accounts using the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account.
See: serviceAccount
smart constructor.
serviceAccount :: ServiceAccount Source #
Creates a value of ServiceAccount
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
saEmail :: Lens' ServiceAccount (Maybe Text) Source #
'OutputOnly Email address of the service account.
saEtag :: Lens' ServiceAccount (Maybe ByteString) Source #
Used to perform a consistent read-modify-write.
saUniqueId :: Lens' ServiceAccount (Maybe Text) Source #
'OutputOnly unique and stable id of the service account.
saName :: Lens' ServiceAccount (Maybe Text) Source #
The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". In requests using '-' as a wildcard for the project, will infer the project from the account and the account value can be the email address or the unique_id of the service account. In responses the resource name will always be in the format "projects/{project}/serviceAccounts/{email}".
saDisplayName :: Lens' ServiceAccount (Maybe Text) Source #
Optional. A user-specified description of the service account. Must be fewer than 100 UTF-8 bytes.
saProjectId :: Lens' ServiceAccount (Maybe Text) Source #
'OutputOnly The id of the project that owns the service account.
saOAuth2ClientId :: Lens' ServiceAccount (Maybe Text) Source #
'OutputOnly. The OAuth2 client id for the service account. This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users.
TestIAMPermissionsRequest
data TestIAMPermissionsRequest Source #
Request message for `TestIamPermissions` method.
See: testIAMPermissionsRequest
smart constructor.
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.
TestIAMPermissionsResponse
data TestIAMPermissionsResponse Source #
Response message for `TestIamPermissions` method.
See: testIAMPermissionsResponse
smart constructor.
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.
Condition
A condition to be met.
See: condition
smart constructor.
cValues :: Lens' Condition [Text] Source #
The objects of the condition. This is mutually exclusive with 'value'.
cValue :: Lens' Condition (Maybe Text) Source #
The object of the condition. Exactly one of these must be set.
cSys :: Lens' Condition (Maybe Text) Source #
Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
SignBlobResponse
data SignBlobResponse Source #
The service account sign blob response.
See: signBlobResponse
smart constructor.
signBlobResponse :: SignBlobResponse Source #
Creates a value of SignBlobResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sbrSignature :: Lens' SignBlobResponse (Maybe ByteString) Source #
The signed blob.
ListServiceAccountsResponse
data ListServiceAccountsResponse Source #
The service account list response.
See: listServiceAccountsResponse
smart constructor.
listServiceAccountsResponse :: ListServiceAccountsResponse Source #
Creates a value of ListServiceAccountsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lsarNextPageToken :: Lens' ListServiceAccountsResponse (Maybe Text) Source #
To retrieve the next page of results, set [ListServiceAccountsRequest.page_token] to this value.
lsarAccounts :: Lens' ListServiceAccountsResponse [ServiceAccount] Source #
The list of matching service accounts.
LogConfig
Specifies what kind of log the caller must write Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. At present only "iam_principal", corresponding to IAMContext.principal, is supported. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support: * multiple field names (though this may be supported in the future) * decrementing the counter * incrementing it by anything other than 1
See: logConfig
smart constructor.
logConfig :: LogConfig Source #
Creates a value of LogConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lcCloudAudit :: Lens' LogConfig (Maybe CloudAuditOptions) Source #
Cloud audit options.
lcDataAccess :: Lens' LogConfig (Maybe DataAccessOptions) Source #
Data access options.
CreateServiceAccountRequest
data CreateServiceAccountRequest Source #
The service account create request.
See: createServiceAccountRequest
smart constructor.
createServiceAccountRequest :: CreateServiceAccountRequest Source #
Creates a value of CreateServiceAccountRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
csarServiceAccount :: Lens' CreateServiceAccountRequest (Maybe ServiceAccount) Source #
The ServiceAccount resource to create. Currently, only the following values are user assignable: display_name .
csarAccountId :: Lens' CreateServiceAccountRequest (Maybe Text) Source #
Required. The account id that is used to generate the service account email address and a stable unique id. It is unique within a project, must be 1-63 characters long, and match the regular expression a-z to comply with RFC1035.
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`.