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

ProjectsLocationsStudies

class ProjectsLocationsStudies extends Resource (View source)

The "studies" collection of methods.

Typical usage is:

 $aiplatformService = new Google\Service\Aiplatform(...);
 $studies = $aiplatformService->projects_locations_studies;

Methods

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

Creates a Study. A resource name will be generated after creation of the Study. (studies.create)

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

Deletes a Study. (studies.delete)

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

Gets a Study by name. (studies.get)

GoogleCloudAiplatformV1ListStudiesResponse
listProjectsLocationsStudies(string $parent, array $optParams = [])

Lists all the studies in a region for an associated project.

GoogleCloudAiplatformV1Study
lookup(string $parent, GoogleCloudAiplatformV1LookupStudyRequest $postBody, array $optParams = [])

Looks a study up using the user-defined display_name field instead of the fully qualified resource name. (studies.lookup)

Details

at line 46
GoogleCloudAiplatformV1Study create(string $parent, GoogleCloudAiplatformV1Study $postBody, array $optParams = [])

Creates a Study. A resource name will be generated after creation of the Study. (studies.create)

Parameters

string $parent

Required. The resource name of the Location to create the CustomJob in. Format: projects/{project}/locations/{location}
GoogleCloudAiplatformV1Study $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1Study

Exceptions

Exception

at line 61
GoogleProtobufEmpty delete(string $name, array $optParams = [])

Deletes a Study. (studies.delete)

Parameters

string $name

Required. The name of the Study resource to be deleted. Format: projects/{project}/locations/{location}/studies/{study}
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

at line 76
GoogleCloudAiplatformV1Study get(string $name, array $optParams = [])

Gets a Study by name. (studies.get)

Parameters

string $name

Required. The name of the Study resource. Format: projects/{project}/locations/{location}/studies/{study}
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1Study

Exceptions

Exception

at line 97
GoogleCloudAiplatformV1ListStudiesResponse listProjectsLocationsStudies(string $parent, array $optParams = [])

Lists all the studies in a region for an associated project.

(studies.listProjectsLocationsStudies)

Parameters

string $parent

Required. The resource name of the Location to list the Study from. Format: projects/{project}/locations/{location}
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1ListStudiesResponse

Exceptions

Exception

at line 114
GoogleCloudAiplatformV1Study lookup(string $parent, GoogleCloudAiplatformV1LookupStudyRequest $postBody, array $optParams = [])

Looks a study up using the user-defined display_name field instead of the fully qualified resource name. (studies.lookup)

Parameters

string $parent

Required. The resource name of the Location to get the Study from. Format: projects/{project}/locations/{location}
GoogleCloudAiplatformV1LookupStudyRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1Study

Exceptions

Exception