1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Config
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsPreviews

ProjectsLocationsPreviews

class ProjectsLocationsPreviews extends Resource (View source)

The "previews" collection of methods.

Typical usage is:

 $configService = new Google\Service\Config(...);
 $previews = $configService->projects_locations_previews;

Methods

Operation
create(string $parent, Preview $postBody, array $optParams = [])

Creates a Preview. (previews.create)

Operation
delete(string $name, array $optParams = [])

Deletes a Preview. (previews.delete)

ExportPreviewResultResponse
export(string $parent, ExportPreviewResultRequest $postBody, array $optParams = [])

Export Preview results. (previews.export)

Preview
get(string $name, array $optParams = [])

Gets details about a Preview. (previews.get)

ListPreviewsResponse
listProjectsLocationsPreviews(string $parent, array $optParams = [])

Lists Previews in a given project and location.

Details

at line 60
Operation create(string $parent, Preview $postBody, array $optParams = [])

Creates a Preview. (previews.create)

Parameters

string $parent

Required. The parent in whose context the Preview is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'.
Preview $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 87
Operation delete(string $name, array $optParams = [])

Deletes a Preview. (previews.delete)

Parameters

string $name

Required. The name of the Preview in the format: 'projects/{project_id}/locations/{location}/previews/{preview}'.
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 104
ExportPreviewResultResponse export(string $parent, ExportPreviewResultRequest $postBody, array $optParams = [])

Export Preview results. (previews.export)

Parameters

string $parent

Required. The preview whose results should be exported. The preview value is in the format: 'projects/{project_id}/locations/{location}/previews/{preview}'.
ExportPreviewResultRequest $postBody
array $optParams

Optional parameters.

Return Value

ExportPreviewResultResponse

Exceptions

Exception

at line 119
Preview get(string $name, array $optParams = [])

Gets details about a Preview. (previews.get)

Parameters

string $name

Required. The name of the preview. Format: 'projects/{project_id}/locations/{location}/previews/{preview}'.
array $optParams

Optional parameters.

Return Value

Preview

Exceptions

Exception

at line 155
ListPreviewsResponse listProjectsLocationsPreviews(string $parent, array $optParams = [])

Lists Previews in a given project and location.

(previews.listProjectsLocationsPreviews)

Parameters

string $parent

Required. The parent in whose context the Previews are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.
array $optParams

Optional parameters.

Return Value

ListPreviewsResponse

Exceptions

Exception