class

GoogleCloudStorage::NotificationsApi

Inherits Reference < Object

Constants

STORAGE_NOTIFICATIONS_DELETE_VALID_VALUES_FOR_ALT = String.static_array("json", "media")

STORAGE_NOTIFICATIONS_GET_VALID_VALUES_FOR_ALT = String.static_array("json", "media")

STORAGE_NOTIFICATIONS_INSERT_VALID_VALUES_FOR_ALT = String.static_array("json", "media")

STORAGE_NOTIFICATIONS_LIST_VALID_VALUES_FOR_ALT = String.static_array("json", "media")

Constructors

new(api_client : GoogleCloudStorage::ApiClient = ApiClient.default)

Instance methods

api_client

api_client=(api_client : ApiClient)

build_api_request_for_delete(*, bucket : String | Nil = nil, notification : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, user_project : String | Nil = nil) : Crest::Request

@return Crest::Request

build_api_request_for_get(*, bucket : String | Nil = nil, notification : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, user_project : String | Nil = nil) : Crest::Request

@return Crest::Request

build_api_request_for_insert(*, bucket : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, user_project : String | Nil = nil, notification : GoogleCloudStorage::Notification | Nil = nil) : Crest::Request

@return Crest::Request

build_api_request_for_list(*, bucket : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, user_project : String | Nil = nil) : Crest::Request

@return Crest::Request

client_side_validation?(*args, **options)

client_side_validation?(*args, **options, &)

debugging?(*args, **options)

debugging?(*args, **options, &)

delete(*, bucket : String | Nil = nil, notification : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, user_project : String | Nil = nil) : Nil

Permanently deletes a notification subscription. @required @param bucket [String?] The parent bucket of the notification. @required @param notification [String?] ID of the notification to delete. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @return [Nil]

delete(*, bucket : String | Nil = nil, notification : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, user_project : String | Nil = nil, &block : Crest::Response -> ) : Nil

Permanently deletes a notification subscription. @required @param bucket [String?] The parent bucket of the notification. @required @param notification [String?] ID of the notification to delete. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @return nil

delete_with_http_info(*, bucket : String | Nil = nil, notification : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, user_project : String | Nil = nil) : Tuple(Nil, Int32, Hash(String, Array(String) | String))

Permanently deletes a notification subscription. @required @param bucket [String?] The parent bucket of the notification. @required @param notification [String?] ID of the notification to delete. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @return [Tuple(Nil, Integer, Hash)] Nil, response status code and response headers

get(*, bucket : String | Nil = nil, notification : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, user_project : String | Nil = nil) : GoogleCloudStorage::Notification

View a notification configuration. @required @param bucket [String?] The parent bucket of the notification. @required @param notification [String?] Notification ID @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @return [GoogleCloudStorage::Notification]

get(*, bucket : String | Nil = nil, notification : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, user_project : String | Nil = nil, &block : Crest::Response -> ) : Nil

View a notification configuration. @required @param bucket [String?] The parent bucket of the notification. @required @param notification [String?] Notification ID @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @return nil

get_with_http_info(*, bucket : String | Nil = nil, notification : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, user_project : String | Nil = nil) : Tuple(GoogleCloudStorage::Notification, Int32, Hash(String, Array(String) | String))

View a notification configuration. @required @param bucket [String?] The parent bucket of the notification. @required @param notification [String?] Notification ID @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @return [Tuple(GoogleCloudStorage::Notification, Integer, Hash)] GoogleCloudStorage::Notification, response status code and response headers

insert(*, bucket : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, user_project : String | Nil = nil, notification : GoogleCloudStorage::Notification | Nil = nil) : GoogleCloudStorage::Notification

Creates a notification subscription for a given bucket. @required @param bucket [String?] The parent bucket of the notification. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @optional @param notification [GoogleCloudStorage::Notification?] @return [GoogleCloudStorage::Notification]

insert(*, bucket : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, user_project : String | Nil = nil, notification : GoogleCloudStorage::Notification | Nil = nil, &block : Crest::Response -> ) : Nil

Creates a notification subscription for a given bucket. @required @param bucket [String?] The parent bucket of the notification. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @optional @param notification [GoogleCloudStorage::Notification?] @return nil

insert_with_http_info(*, bucket : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, user_project : String | Nil = nil, notification : GoogleCloudStorage::Notification | Nil = nil) : Tuple(GoogleCloudStorage::Notification, Int32, Hash(String, Array(String) | String))

Creates a notification subscription for a given bucket. @required @param bucket [String?] The parent bucket of the notification. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @optional @param notification [GoogleCloudStorage::Notification?] @return [Tuple(GoogleCloudStorage::Notification, Integer, Hash)] GoogleCloudStorage::Notification, response status code and response headers

list(*, bucket : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, user_project : String | Nil = nil) : GoogleCloudStorage::Notifications

Retrieves a list of notification subscriptions for a given bucket. @required @param bucket [String?] Name of a Google Cloud Storage bucket. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @return [GoogleCloudStorage::Notifications]

list(*, bucket : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, user_project : String | Nil = nil, &block : Crest::Response -> ) : Nil

Retrieves a list of notification subscriptions for a given bucket. @required @param bucket [String?] Name of a Google Cloud Storage bucket. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @return nil

list_with_http_info(*, bucket : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, user_project : String | Nil = nil) : Tuple(GoogleCloudStorage::Notifications, Int32, Hash(String, Array(String) | String))

Retrieves a list of notification subscriptions for a given bucket. @required @param bucket [String?] Name of a Google Cloud Storage bucket. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @return [Tuple(GoogleCloudStorage::Notifications, Integer, Hash)] GoogleCloudStorage::Notifications, response status code and response headers