Google Cloud BigQuery Data Policies V1beta1 Client - Class DataPolicyServiceClient (0.1.1)

Reference documentation and code samples for the Google Cloud BigQuery Data Policies V1beta1 Client class DataPolicyServiceClient.

Service Description: Data Policy Service provides APIs for managing the label-policy bindings.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

$dataPolicyServiceClient = new DataPolicyServiceClient();
try {
    $formattedParent = $dataPolicyServiceClient->locationName('[PROJECT]', '[LOCATION]');
    $dataPolicy = new DataPolicy();
    $response = $dataPolicyServiceClient->createDataPolicy($formattedParent, $dataPolicy);
} finally {
    $dataPolicyServiceClient->close();
}

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Methods

dataPolicyName

Formats a string containing the fully-qualified path to represent a data_policy resource.

Parameters
NameDescription
project string
location string
dataPolicy string
Returns
TypeDescription
stringThe formatted data_policy resource.

locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
NameDescription
project string
location string
Returns
TypeDescription
stringThe formatted location resource.

parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

  • dataPolicy: projects/{project}/locations/{location}/dataPolicies/{data_policy}
  • location: projects/{project}/locations/{location}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
NameDescription
formattedName string

The formatted name string

template string

Optional name of template to match

Returns
TypeDescription
arrayAn associative array from name component IDs to component values.

__construct

Constructor.

Parameters
NameDescription
options array

Optional. Options for configuring the service API wrapper.

↳ apiEndpoint string

The address of the API remote host. May optionally include the port, formatted as "

↳ credentials string|array|FetchAuthTokenInterface|CredentialsWrapper

The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed {@see} object or {@see} object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.

↳ credentialsConfig array

Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see {@see} .

↳ disableRetries bool

Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.

↳ clientConfig string|array

Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.

↳ transport string|TransportInterface

The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated {@see} object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.

↳ transportConfig array

Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the {@see} and {@see} methods for the supported options.

↳ clientCertSource callable

A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

createDataPolicy

Creates a new data policy under a project with the given dataPolicyId (used as the display name), policy tag, and data policy type.

Sample code:

$dataPolicyServiceClient = new DataPolicyServiceClient();
try {
    $formattedParent = $dataPolicyServiceClient->locationName('[PROJECT]', '[LOCATION]');
    $dataPolicy = new DataPolicy();
    $response = $dataPolicyServiceClient->createDataPolicy($formattedParent, $dataPolicy);
} finally {
    $dataPolicyServiceClient->close();
}
Parameters
NameDescription
parent string

Required. Resource name of the project that the data policy will belong to. The format is projects/{project_number}/locations/{location_id}.

dataPolicy Google\Cloud\BigQuery\DataPolicies\V1beta1\DataPolicy

Required. The data policy to create. The name field does not need to be provided for the data policy creation.

optionalArgs array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
TypeDescription
Google\Cloud\BigQuery\DataPolicies\V1beta1\DataPolicy

deleteDataPolicy

Deletes the data policy specified by its resource name.

Sample code:

$dataPolicyServiceClient = new DataPolicyServiceClient();
try {
    $formattedName = $dataPolicyServiceClient->dataPolicyName('[PROJECT]', '[LOCATION]', '[DATA_POLICY]');
    $dataPolicyServiceClient->deleteDataPolicy($formattedName);
} finally {
    $dataPolicyServiceClient->close();
}
Parameters
NameDescription
name string

Required. Resource name of the data policy to delete. Format is projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}.

optionalArgs array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

getDataPolicy

Gets the data policy specified by its resource name.

Sample code:

$dataPolicyServiceClient = new DataPolicyServiceClient();
try {
    $formattedName = $dataPolicyServiceClient->dataPolicyName('[PROJECT]', '[LOCATION]', '[DATA_POLICY]');
    $response = $dataPolicyServiceClient->getDataPolicy($formattedName);
} finally {
    $dataPolicyServiceClient->close();
}
Parameters
NameDescription
name string

Required. Resource name of the requested data policy. Format is projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}.

optionalArgs array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
TypeDescription
Google\Cloud\BigQuery\DataPolicies\V1beta1\DataPolicy

getIamPolicy

Gets the IAM policy for the specified data policy.

Sample code:

$dataPolicyServiceClient = new DataPolicyServiceClient();
try {
    $resource = 'resource';
    $response = $dataPolicyServiceClient->getIamPolicy($resource);
} finally {
    $dataPolicyServiceClient->close();
}
Parameters
NameDescription
resource string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

optionalArgs array

Optional.

↳ options GetPolicyOptions

OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
TypeDescription
Google\Cloud\Iam\V1\Policy

listDataPolicies

List all of the data policies in the specified parent project.

Sample code:

$dataPolicyServiceClient = new DataPolicyServiceClient();
try {
    $formattedParent = $dataPolicyServiceClient->locationName('[PROJECT]', '[LOCATION]');
    // Iterate over pages of elements
    $pagedResponse = $dataPolicyServiceClient->listDataPolicies($formattedParent);
    foreach ($pagedResponse->iteratePages() as $page) {
        foreach ($page as $element) {
            // doSomethingWith($element);
        }
    }
    // Alternatively:
    // Iterate through all elements
    $pagedResponse = $dataPolicyServiceClient->listDataPolicies($formattedParent);
    foreach ($pagedResponse->iterateAllElements() as $element) {
        // doSomethingWith($element);
    }
} finally {
    $dataPolicyServiceClient->close();
}
Parameters
NameDescription
parent string

Required. Resource name of the project for which to list data policies. Format is projects/{project_number}/locations/{location_id}.

optionalArgs array

Optional.

↳ pageSize int

The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.

↳ pageToken string

A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
TypeDescription
Google\ApiCore\PagedListResponse

setIamPolicy

Sets the IAM policy for the specified data policy.

Sample code:

$dataPolicyServiceClient = new DataPolicyServiceClient();
try {
    $resource = 'resource';
    $policy = new Policy();
    $response = $dataPolicyServiceClient->setIamPolicy($resource, $policy);
} finally {
    $dataPolicyServiceClient->close();
}
Parameters
NameDescription
resource string

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

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

optionalArgs array

Optional.

↳ updateMask FieldMask

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"

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
TypeDescription
Google\Cloud\Iam\V1\Policy

testIamPermissions

Returns the caller's permission on the specified data policy resource.

Sample code:

$dataPolicyServiceClient = new DataPolicyServiceClient();
try {
    $resource = 'resource';
    $permissions = [];
    $response = $dataPolicyServiceClient->testIamPermissions($resource, $permissions);
} finally {
    $dataPolicyServiceClient->close();
}
Parameters
NameDescription
resource string

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

permissions string[]

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.

optionalArgs array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
TypeDescription
Google\Cloud\Iam\V1\TestIamPermissionsResponse

updateDataPolicy

Updates the metadata for an existing data policy. The target data policy can be specified by the resource name.

Sample code:

$dataPolicyServiceClient = new DataPolicyServiceClient();
try {
    $dataPolicy = new DataPolicy();
    $response = $dataPolicyServiceClient->updateDataPolicy($dataPolicy);
} finally {
    $dataPolicyServiceClient->close();
}
Parameters
NameDescription
dataPolicy Google\Cloud\BigQuery\DataPolicies\V1beta1\DataPolicy

Required. Update the data policy's metadata. The target data policy is determined by the name field. Other fields are updated to the specified values based on the field masks.

optionalArgs array

Optional.

↳ updateMask FieldMask

The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If not set, defaults to all of the fields that are allowed to update. Updates to the name and dataPolicyId fields are not allowed.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
TypeDescription
Google\Cloud\BigQuery\DataPolicies\V1beta1\DataPolicy

Constants

SERVICE_NAME

Value: 'google.cloud.bigquery.datapolicies.v1beta1.DataPolicyService'

The name of the service.

SERVICE_ADDRESS

Value: 'bigquerydatapolicy.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.