cloud.google.com/go/aiplatform@v1.106.0/apiv1beta1/doc.go (about)

     1  // Copyright 2025 Google LLC
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     https://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // Code generated by protoc-gen-go_gapic. DO NOT EDIT.
    16  
    17  // Package aiplatform is an auto-generated package for the
    18  // Vertex AI API.
    19  //
    20  // Train high-quality custom machine learning models with minimal machine
    21  // learning expertise and effort.
    22  //
    23  //	NOTE: This package is in beta. It is not stable, and may be subject to changes.
    24  //
    25  // # General documentation
    26  //
    27  // For information that is relevant for all client libraries please reference
    28  // https://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on this
    29  // page includes:
    30  //
    31  //   - [Authentication and Authorization]
    32  //   - [Timeouts and Cancellation]
    33  //   - [Testing against Client Libraries]
    34  //   - [Debugging Client Libraries]
    35  //   - [Inspecting errors]
    36  //
    37  // # Example usage
    38  //
    39  // To get started with this package, create a client.
    40  //
    41  //	// go get cloud.google.com/go/aiplatform/apiv1beta1@latest
    42  //	ctx := context.Background()
    43  //	// This snippet has been automatically generated and should be regarded as a code template only.
    44  //	// It will require modifications to work:
    45  //	// - It may require correct/in-range values for request initialization.
    46  //	// - It may require specifying regional endpoints when creating the service client as shown in:
    47  //	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
    48  //	c, err := aiplatform.NewDatasetClient(ctx)
    49  //	if err != nil {
    50  //		// TODO: Handle error.
    51  //	}
    52  //	defer c.Close()
    53  //
    54  // The client will use your default application credentials. Clients should be reused instead of created as needed.
    55  // The methods of Client are safe for concurrent use by multiple goroutines.
    56  // The returned client must be Closed when it is done being used.
    57  //
    58  // # Using the Client
    59  //
    60  // The following is an example of making an API call with the newly created client, mentioned above.
    61  //
    62  //	req := &aiplatformpb.AssembleDataRequest{
    63  //		// TODO: Fill request struct fields.
    64  //		// See https://pkg.go.dev/cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb#AssembleDataRequest.
    65  //	}
    66  //	op, err := c.AssembleData(ctx, req)
    67  //	if err != nil {
    68  //		// TODO: Handle error.
    69  //	}
    70  //
    71  //	resp, err := op.Wait(ctx)
    72  //	if err != nil {
    73  //		// TODO: Handle error.
    74  //	}
    75  //	// TODO: Use resp.
    76  //	_ = resp
    77  //
    78  // # Use of Context
    79  //
    80  // The ctx passed to NewDatasetClient is used for authentication requests and
    81  // for creating the underlying connection, but is not used for subsequent calls.
    82  // Individual methods on the client use the ctx given to them.
    83  //
    84  // To close the open connection, use the Close() method.
    85  //
    86  // [Authentication and Authorization]: https://pkg.go.dev/cloud.google.com/go#hdr-Authentication_and_Authorization
    87  // [Timeouts and Cancellation]: https://pkg.go.dev/cloud.google.com/go#hdr-Timeouts_and_Cancellation
    88  // [Testing against Client Libraries]: https://pkg.go.dev/cloud.google.com/go#hdr-Testing
    89  // [Debugging Client Libraries]: https://pkg.go.dev/cloud.google.com/go#hdr-Debugging
    90  // [Inspecting errors]: https://pkg.go.dev/cloud.google.com/go#hdr-Inspecting_errors
    91  package aiplatform // import "cloud.google.com/go/aiplatform/apiv1beta1"