...

Source file src/cloud.google.com/go/logging/apiv2/doc.go

Documentation: cloud.google.com/go/logging/apiv2

     1  // Copyright 2024 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 logging is an auto-generated package for the
    18  // Cloud Logging API.
    19  //
    20  // Writes log entries and manages your Cloud Logging configuration.
    21  //
    22  // # General documentation
    23  //
    24  // For information that is relevant for all client libraries please reference
    25  // https://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on this
    26  // page includes:
    27  //
    28  //   - [Authentication and Authorization]
    29  //   - [Timeouts and Cancellation]
    30  //   - [Testing against Client Libraries]
    31  //   - [Debugging Client Libraries]
    32  //   - [Inspecting errors]
    33  //
    34  // # Example usage
    35  //
    36  // To get started with this package, create a client.
    37  //
    38  //	ctx := context.Background()
    39  //	// This snippet has been automatically generated and should be regarded as a code template only.
    40  //	// It will require modifications to work:
    41  //	// - It may require correct/in-range values for request initialization.
    42  //	// - It may require specifying regional endpoints when creating the service client as shown in:
    43  //	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
    44  //	c, err := logging.NewClient(ctx)
    45  //	if err != nil {
    46  //		// TODO: Handle error.
    47  //	}
    48  //	defer c.Close()
    49  //
    50  // The client will use your default application credentials. Clients should be reused instead of created as needed.
    51  // The methods of Client are safe for concurrent use by multiple goroutines.
    52  // The returned client must be Closed when it is done being used.
    53  //
    54  // # Using the Client
    55  //
    56  // The following is an example of making an API call with the newly created client.
    57  //
    58  //	ctx := context.Background()
    59  //	// This snippet has been automatically generated and should be regarded as a code template only.
    60  //	// It will require modifications to work:
    61  //	// - It may require correct/in-range values for request initialization.
    62  //	// - It may require specifying regional endpoints when creating the service client as shown in:
    63  //	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
    64  //	c, err := logging.NewClient(ctx)
    65  //	if err != nil {
    66  //		// TODO: Handle error.
    67  //	}
    68  //	defer c.Close()
    69  //
    70  //	req := &loggingpb.DeleteLogRequest{
    71  //		// TODO: Fill request struct fields.
    72  //		// See https://pkg.go.dev/cloud.google.com/go/logging/apiv2/loggingpb#DeleteLogRequest.
    73  //	}
    74  //	err = c.DeleteLog(ctx, req)
    75  //	if err != nil {
    76  //		// TODO: Handle error.
    77  //	}
    78  //
    79  // # Use of Context
    80  //
    81  // The ctx passed to NewClient is used for authentication requests and
    82  // for creating the underlying connection, but is not used for subsequent calls.
    83  // Individual methods on the client use the ctx given to them.
    84  //
    85  // To close the open connection, use the Close() method.
    86  //
    87  // [Authentication and Authorization]: https://pkg.go.dev/cloud.google.com/go#hdr-Authentication_and_Authorization
    88  // [Timeouts and Cancellation]: https://pkg.go.dev/cloud.google.com/go#hdr-Timeouts_and_Cancellation
    89  // [Testing against Client Libraries]: https://pkg.go.dev/cloud.google.com/go#hdr-Testing
    90  // [Debugging Client Libraries]: https://pkg.go.dev/cloud.google.com/go#hdr-Debugging
    91  // [Inspecting errors]: https://pkg.go.dev/cloud.google.com/go#hdr-Inspecting_errors
    92  package logging // import "cloud.google.com/go/logging/apiv2"
    93  
    94  import (
    95  	"context"
    96  
    97  	"google.golang.org/api/option"
    98  )
    99  
   100  // For more information on implementing a client constructor hook, see
   101  // https://github.com/googleapis/google-cloud-go/wiki/Customizing-constructors.
   102  type clientHookParams struct{}
   103  type clientHook func(context.Context, clientHookParams) ([]option.ClientOption, error)
   104  
   105  var versionClient string
   106  
   107  func getVersionClient() string {
   108  	if versionClient == "" {
   109  		return "UNKNOWN"
   110  	}
   111  	return versionClient
   112  }
   113  
   114  // DefaultAuthScopes reports the default set of authentication scopes to use with this package.
   115  func DefaultAuthScopes() []string {
   116  	return []string{
   117  		"https://www.googleapis.com/auth/cloud-platform",
   118  		"https://www.googleapis.com/auth/cloud-platform.read-only",
   119  		"https://www.googleapis.com/auth/logging.admin",
   120  		"https://www.googleapis.com/auth/logging.read",
   121  		"https://www.googleapis.com/auth/logging.write",
   122  	}
   123  }
   124  

View as plain text