sty_shared

Documentation

Overview

Package sty_shared

This is the STY-Holdings shared services

NOTES:

None

COPYRIGHT & WARRANTY:

Copyright (c) 2022 STY-Holdings, inc
All rights reserved.

This software is the confidential and proprietary information of STY-Holdings, Inc.
Use is subject to license terms.

Unauthorized copying of this file, via any medium is strictly prohibited.

Proprietary and confidential

Written by <Replace with FULL_NAME> / syacko
STY-Holdings, Inc.
support@sty-holdings.com
www.sty-holdings.com

01-2024
USA

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Package sty_shared

This is the STY-Holdings shared services

NOTES:

None

COPYRIGHT & WARRANTY:

Copyright (c) 2022 STY-Holdings, inc
All rights reserved.

This software is the confidential and proprietary information of STY-Holdings, Inc.
Use is subject to license terms.

Unauthorized copying of this file, via any medium is strictly prohibited.

Proprietary and confidential

Written by <Replace with FULL_NAME> / syacko
STY-Holdings, Inc.
support@sty-holdings.com
www.sty-holdings.com

01-2024
USA

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Index

• func CreateStorageClient(credentialsFile string, test bool) (client *storage.Client, errorInfo pi.ErrorInfo)
• func ListObjectsInBucket(storageClientPtr *storage.Client, bucketName string) (bucketList []string, errorInfo pi.ErrorInfo)
• func ReadBucketObject(storageClientPtr *storage.Client, bucketName string, fileName string) (contents []byte, errorInfo pi.ErrorInfo)

Functions

func CreateStorageClient

func CreateStorageClient(
	credentialsFile string,
	test bool,
) (
	client *storage.Client,
	errorInfo pi.ErrorInfo,
)

CreateStorageClient - connect to Google Cloud Platform services

Customer Messages: None
Errors: Return an errors generated by GCP with Ending Execution appended
Verifications: None

func ListObjectsInBucket

func ListObjectsInBucket(
	storageClientPtr *storage.Client,
	bucketName string,
) (
	bucketList []string,
	errorInfo pi.ErrorInfo,
)

ListFilesInBucket - return all the object names in a bucket, folders and files

Customer Messages: None
Errors: ErrRequiredArgumentMissing
Verifications: storageClientPtr is not nil

func ReadBucketObject

func ReadBucketObject(
	storageClientPtr *storage.Client,
	bucketName string,
	fileName string,
) (
	contents []byte,
	errorInfo pi.ErrorInfo,
)

ReadBucketObject - returns the contains of the bucket's named file.

Customer Messages: None
Errors: ErrRequiredArgumentMissing
Verifications: bucketPtr is not nil