View Source GoogleApi.CloudControlsPartner.V1.Api.Organizations (google_api_cloud_controls_partner v0.3.3)

API calls for all endpoints tagged Organizations.

Summary

Functions

Lists customers of a partner identified by its Google Cloud organization ID

Deprecated: Only returns access approval requests directly associated with an assured workload folder.

Lists Violations for a workload Callers may also choose to read across multiple Customers or for a single customer as per AIP-159 by using '-' (the hyphen or dash character) as a wildcard character instead of {customer} & {workload}. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}

Functions

Link to this function

cloudcontrolspartner_organizations_locations_customers_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec cloudcontrolspartner_organizations_locations_customers_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudControlsPartner.V1.Model.Customer.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets details of a single customer

Parameters

  • connection (type: GoogleApi.CloudControlsPartner.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Format: organizations/{organization}/locations/{location}/customers/{customer}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudControlsPartner.V1.Model.Customer{}} on success
  • {:error, info} on failure
Link to this function

cloudcontrolspartner_organizations_locations_customers_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec cloudcontrolspartner_organizations_locations_customers_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudControlsPartner.V1.Model.ListCustomersResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists customers of a partner identified by its Google Cloud organization ID

Parameters

  • connection (type: GoogleApi.CloudControlsPartner.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Parent resource Format: organizations/{organization}/locations/{location}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - Optional. Filtering results
    • :orderBy (type: String.t) - Optional. Hint for how to order the results
    • :pageSize (type: integer()) - The maximum number of Customers to return. The service may return fewer than this value. If unspecified, at most 500 Customers will be returned.
    • :pageToken (type: String.t) - A page token, received from a previous ListCustomers call. Provide this to retrieve the subsequent page.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudControlsPartner.V1.Model.ListCustomersResponse{}} on success
  • {:error, info} on failure
Link to this function

cloudcontrolspartner_organizations_locations_customers_workloads_access_approval_requests_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec cloudcontrolspartner_organizations_locations_customers_workloads_access_approval_requests_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.CloudControlsPartner.V1.Model.ListAccessApprovalRequestsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deprecated: Only returns access approval requests directly associated with an assured workload folder.

Parameters

  • connection (type: GoogleApi.CloudControlsPartner.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Parent resource Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - Optional. Filtering results.
    • :orderBy (type: String.t) - Optional. Hint for how to order the results.
    • :pageSize (type: integer()) - Optional. The maximum number of access requests to return. The service may return fewer than this value. If unspecified, at most 500 access requests will be returned.
    • :pageToken (type: String.t) - Optional. A page token, received from a previous ListAccessApprovalRequests call. Provide this to retrieve the subsequent page.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudControlsPartner.V1.Model.ListAccessApprovalRequestsResponse{}} on success
  • {:error, info} on failure
Link to this function

cloudcontrolspartner_organizations_locations_customers_workloads_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec cloudcontrolspartner_organizations_locations_customers_workloads_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudControlsPartner.V1.Model.Workload.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets details of a single workload

Parameters

  • connection (type: GoogleApi.CloudControlsPartner.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudControlsPartner.V1.Model.Workload{}} on success
  • {:error, info} on failure
Link to this function

cloudcontrolspartner_organizations_locations_customers_workloads_get_ekm_connections(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec cloudcontrolspartner_organizations_locations_customers_workloads_get_ekm_connections(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudControlsPartner.V1.Model.EkmConnections.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the EKM connections associated with a workload

Parameters

  • connection (type: GoogleApi.CloudControlsPartner.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudControlsPartner.V1.Model.EkmConnections{}} on success
  • {:error, info} on failure
Link to this function

cloudcontrolspartner_organizations_locations_customers_workloads_get_partner_permissions(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec cloudcontrolspartner_organizations_locations_customers_workloads_get_partner_permissions(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudControlsPartner.V1.Model.PartnerPermissions.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the partner permissions granted for a workload

Parameters

  • connection (type: GoogleApi.CloudControlsPartner.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Name of the resource to get in the format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/partnerPermissions
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudControlsPartner.V1.Model.PartnerPermissions{}} on success
  • {:error, info} on failure
Link to this function

cloudcontrolspartner_organizations_locations_customers_workloads_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec cloudcontrolspartner_organizations_locations_customers_workloads_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudControlsPartner.V1.Model.ListWorkloadsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists customer workloads for a given customer org id

Parameters

  • connection (type: GoogleApi.CloudControlsPartner.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Parent resource Format: organizations/{organization}/locations/{location}/customers/{customer}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - Optional. Filtering results.
    • :orderBy (type: String.t) - Optional. Hint for how to order the results.
    • :pageSize (type: integer()) - The maximum number of workloads to return. The service may return fewer than this value. If unspecified, at most 500 workloads will be returned.
    • :pageToken (type: String.t) - A page token, received from a previous ListWorkloads call. Provide this to retrieve the subsequent page.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudControlsPartner.V1.Model.ListWorkloadsResponse{}} on success
  • {:error, info} on failure
Link to this function

cloudcontrolspartner_organizations_locations_customers_workloads_violations_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec cloudcontrolspartner_organizations_locations_customers_workloads_violations_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudControlsPartner.V1.Model.Violation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets details of a single Violation.

Parameters

  • connection (type: GoogleApi.CloudControlsPartner.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/violations/{violation}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudControlsPartner.V1.Model.Violation{}} on success
  • {:error, info} on failure
Link to this function

cloudcontrolspartner_organizations_locations_customers_workloads_violations_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec cloudcontrolspartner_organizations_locations_customers_workloads_violations_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudControlsPartner.V1.Model.ListViolationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists Violations for a workload Callers may also choose to read across multiple Customers or for a single customer as per AIP-159 by using '-' (the hyphen or dash character) as a wildcard character instead of {customer} & {workload}. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}

Parameters

  • connection (type: GoogleApi.CloudControlsPartner.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Parent resource Format organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - Optional. Filtering results
    • :"interval.endTime" (type: DateTime.t) - Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
    • :"interval.startTime" (type: DateTime.t) - Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
    • :orderBy (type: String.t) - Optional. Hint for how to order the results
    • :pageSize (type: integer()) - Optional. The maximum number of customers row to return. The service may return fewer than this value. If unspecified, at most 10 customers will be returned.
    • :pageToken (type: String.t) - Optional. A page token, received from a previous ListViolations call. Provide this to retrieve the subsequent page.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudControlsPartner.V1.Model.ListViolationsResponse{}} on success
  • {:error, info} on failure
Link to this function

cloudcontrolspartner_organizations_locations_get_partner(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec cloudcontrolspartner_organizations_locations_get_partner(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudControlsPartner.V1.Model.Partner.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Get details of a Partner.

Parameters

  • connection (type: GoogleApi.CloudControlsPartner.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Format: organizations/{organization}/locations/{location}/partner
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudControlsPartner.V1.Model.Partner{}} on success
  • {:error, info} on failure