chore: mark connection classes and ConnectionInterface as deprecated …

…(#6616)

src/Acl.php

@@ -45,6 +45,7 @@ class Acl
 
     /**
      * @var ConnectionInterface Represents a connection to Cloud Storage.
+     * @internal
      */
     protected $connection;
 
@@ -55,7 +56,8 @@ class Acl
 
     /**
      * @param ConnectionInterface $connection Represents a connection to
-     *        Cloud Storage.
+     *        Cloud Storage. This object is created by StorageClient,
+     *        and should not be instantiated outside of this client.
      * @param string $type The type of access control this instance applies to.
      * @param array $identity Represents which bucket, file, or generation this
      *        instance applies to.

src/Bucket.php

@@ -65,6 +65,7 @@ class Bucket
 
     /**
      * @var ConnectionInterface Represents a connection to Cloud Storage.
+     * @internal
      */
     private $connection;
 
@@ -95,7 +96,8 @@ class Bucket
 
     /**
      * @param ConnectionInterface $connection Represents a connection to Cloud
-     *        Storage.
+     *        Storage. This object is created by StorageClient,
+     *        and should not be instantiated outside of this client.
      * @param string $name The bucket's name.
      * @param array $info [optional] The bucket's metadata.
      */

src/Connection/ConnectionInterface.php

@@ -20,6 +20,8 @@
 /**
  * Represents a connection to
  * [Cloud Storage](https://cloud.google.com/storage/).
+ *
+ * @internal
  */
 interface ConnectionInterface
 {

src/Connection/IamBucket.php

@@ -21,6 +21,8 @@
 
 /**
  * IAM Implementation for GCS Buckets
+ *
+ * @internal
  */
 class IamBucket implements IamConnectionInterface
 {

src/Connection/Rest.php

@@ -41,6 +41,8 @@
 /**
  * Implementation of the
  * [Google Cloud Storage JSON API](https://cloud.google.com/storage/docs/json_api/).
+ *
+ * @internal
  */
 class Rest implements ConnectionInterface
 {

src/HmacKey.php

@@ -34,6 +34,7 @@ class HmacKey
 {
     /**
      * @var ConnectionInterface
+     * @internal
      */
     private $connection;
 
@@ -54,6 +55,8 @@ class HmacKey
 
     /**
      * @param ConnectionInterface $connection A connection to Cloud Storage.
+     *        This object is created by StorageClient,
+     *        and should not be instantiated outside of this client.
      * @param string $projectId The current project ID.
      * @param string $accessId The key identifier.
      * @param array|null $info The key metadata.

src/Notification.php

@@ -55,6 +55,7 @@ class Notification
 
     /**
      * @var ConnectionInterface Represents a connection to Cloud Storage.
+     * @internal
      */
     private $connection;
 
@@ -70,7 +71,8 @@ class Notification
 
     /**
      * @param ConnectionInterface $connection Represents a connection to Cloud
-     *        Storage.
+     *        Storage. This object is created by StorageClient,
+     *        and should not be instantiated outside of this client.
      * @param string $id The notification's ID.
      * @param string $bucket The name of the bucket associated with this
      *        notification.

src/SigningHelper.php

@@ -60,7 +60,8 @@ public static function getHelper()
      * Sign using the version inferred from `$options.version`.
      *
      * @param ConnectionInterface $connection A connection to the Cloud Storage
-     *        API.
+     *        API. This object is created by StorageClient,
+     *        and should not be instantiated outside of this client.
      * @param Timestamp|\DateTimeInterface|int $expires The signed URL
      *        expiration.
      * @param string $resource The URI to the storage resource, preceded by a
@@ -110,7 +111,8 @@ public function sign(ConnectionInterface $connection, $expires, $resource, $gene
      * This method will be deprecated in the future.
      *
      * @param ConnectionInterface $connection A connection to the Cloud Storage
-     *        API.
+     *        API. This object is created by StorageClient,
+     *        and should not be instantiated outside of this client.
      * @param Timestamp|\DateTimeInterface|int $expires The signed URL
      *        expiration.
      * @param string $resource The URI to the storage resource, preceded by a
@@ -206,7 +208,8 @@ public function v2Sign(ConnectionInterface $connection, $expires, $resource, $ge
      * Sign a storage URL using Google Signed URLs v4.
      *
      * @param ConnectionInterface $connection A connection to the Cloud Storage
-     *        API.
+     *        API. This object is created by StorageClient,
+     *        and should not be instantiated outside of this client.
      * @param Timestamp|\DateTimeInterface|int $expires The signed URL
      *        expiration.
      * @param string $resource The URI to the storage resource, preceded by a
@@ -362,6 +365,8 @@ public function v4Sign(ConnectionInterface $connection, $expires, $resource, $ge
      * Create an HTTP POST policy using v4 signing.
      *
      * @param ConnectionInterface $connection A Connection to Google Cloud Storage.
+     *        This object is created by StorageClient,
+     *        and should not be instantiated outside of this client.
      * @param Timestamp|\DateTimeInterface|int $expires The signed URL
      *        expiration.
      * @param string $resource The URI to the storage resource, preceded by a
@@ -780,6 +785,8 @@ private function normalizeCanonicalRequestResource($resource, $bucketBoundHostna
      * Get the credentials for use with signing.
      *
      * @param ConnectionInterface $connection A Storage connection object.
+     *        This object is created by StorageClient,
+     *        and should not be instantiated outside of this client.
      * @param array $options Configuration options.
      * @return array A list containing a credentials object at index 0 and the
      *        modified options at index 1.

src/StorageClient.php

@@ -73,6 +73,7 @@ class StorageClient
 
     /**
      * @var ConnectionInterface Represents a connection to Storage.
+     * @internal
      */
     protected $connection;
 

src/StorageObject.php

@@ -57,6 +57,7 @@ class StorageObject
 
     /**
      * @var ConnectionInterface Represents a connection to Cloud Storage.
+     * @internal
      */
     protected $connection;
 
@@ -77,7 +78,8 @@ class StorageObject
 
     /**
      * @param ConnectionInterface $connection Represents a connection to Cloud
-     *        Storage.
+     *        Storage. This object is created by StorageClient,
+     *        and should not be instantiated outside of this client.
      * @param string $name The object's name.
      * @param string $bucket The name of the bucket the object is contained in.
      * @param string $generation [optional] The generation of the object.