feat: Migrate to Google Merchant API and remove Composer dependencies

- Fix ISE 500 error on plugin activation:
  - Defer wc_get_logger() call in Logger class (lazy initialization)
  - Move plugin init to plugins_loaded hook with priority 20
  - Remove invalid Google_Service_ShoppingContent_Reports instantiation

- Migrate from deprecated Content API to new Merchant API:
  - Rewrite Google API class with direct REST calls
  - Implement JWT authentication using PHP OpenSSL
  - Use WordPress wp_remote_* functions for HTTP requests
  - Support Price Competitiveness reports for competitor pricing

- Remove all Composer dependencies:
  - Delete vendor/ directory (~50 packages)
  - Delete composer.json and composer.lock
  - Remove setup scripts and related documentation

- Plugin is now fully self-contained with no external dependencies

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
2026-01-21 08:29:25 +01:00
parent 366352fb14
commit d1f3607895
32462 changed files with 344 additions and 4063131 deletions

View File

@@ -1,261 +0,0 @@
# File Manifest
Complete list of all files in the Informatiq Smart Google Pricing plugin.
## Core Plugin Files
### Main Files
- **`informatiq-smart-google-pricing.php`** - Main plugin file with activation/deactivation hooks
- **`uninstall.php`** - Clean uninstall script (removes all data)
- **`composer.json`** - Composer configuration for Google API Client
- **`.gitignore`** - Git ignore rules (includes vendor for distribution)
## Includes Directory (`includes/`)
Core functionality classes:
- **`class-informatiq-sp-logger.php`** - Logging system
- WC_Logger integration
- Custom database table for price update logs
- Methods: `log_price_update()`, `get_todays_logs()`, `clear_old_logs()`
- **`class-informatiq-sp-google-api.php`** - Google Merchant Center API
- Service Account authentication
- Product matching via SKU/GTIN
- Competitive pricing retrieval
- Methods: `get_competitive_price()`, `test_connection()`
- **`class-informatiq-sp-price-updater.php`** - Price calculation logic
- Tax-aware pricing (handles WooCommerce tax settings)
- Minimum margin protection
- Random offset calculation (0.05-0.20)
- In-stock product filtering
- Methods: `process_all_products()`, `process_product_by_id()`
- **`class-informatiq-sp-scheduler.php`** - WP Cron automation
- Daily/twice daily/6-hour schedules
- Automatic price update execution
- Last run tracking
- Methods: `run_daily_update()`, `trigger_manual_update()`, `reschedule()`
## Admin Directory (`admin/`)
- **`class-informatiq-sp-admin.php`** - WordPress admin interface
- Settings page under WooCommerce menu
- Form fields for all settings
- AJAX handlers for manual sync and connection test
- Logs display
- Methods: `render_admin_page()`, `handle_manual_sync()`, `handle_test_connection()`
## Assets Directory (`assets/`)
### CSS (`assets/css/`)
- **`admin.css`** - Admin page styling
- Responsive layout (sidebar + main content)
- Status boxes and buttons
- Loading states and animations
- Table styling for logs
### JavaScript (`assets/js/`)
- **`admin.js`** - Admin interactivity
- Manual sync AJAX handler
- Test connection AJAX handler
- Loading states
- Error/success message display
## Vendor Directory (`vendor/`)
- **`autoload.php`** - Custom autoloader
- Works with Composer-installed libraries
- Works with manually placed libraries
- Supports both PSR-4 and old-style class names
- Shows admin notice if dependencies missing
**Expected structure after setup:**
```
vendor/
├── autoload.php (included in plugin)
├── google/
│ ├── apiclient/
│ └── apiclient-services/
├── guzzlehttp/
├── psr/
├── firebase/
└── monolog/
```
## Languages Directory (`languages/`)
- **`informatiq-smart-pricing.pot`** - Translation template
- All translatable strings
- Ready for localization
## Documentation Files
### User Documentation
- **`README.md`** - Complete plugin documentation
- Features overview
- Installation instructions
- Configuration guide
- How it works
- API reference
- **`QUICKSTART.md`** - 10-minute setup guide
- Quick setup for developers
- Quick setup for end users
- Common troubleshooting
- Next steps
- **`INSTALLATION.md`** - Detailed installation guide
- Google Service Account setup
- Plugin configuration
- Product requirements
- Advanced configuration
- Security recommendations
- **`VENDOR-SETUP.md`** - Vendor library setup guide
- Manual download instructions
- Composer installation
- Directory structure
- Simplified installation methods
### Developer Documentation
- **`FILE-MANIFEST.md`** - This file
- Complete file listing
- Purpose of each file
- Code references
## Utility Scripts
- **`setup-vendor.sh`** - Automated vendor setup script
- Checks for Composer
- Installs Google API Client
- Optimizes autoloader
- Shows installation summary
- Usage: `./setup-vendor.sh`
## File Statistics
### PHP Files
- Total: 7 core PHP files
- Lines of code: ~2,500+ lines
- Classes: 5 main classes
- Functions: 50+ methods
### Assets
- CSS: 1 file (~300 lines)
- JavaScript: 1 file (~150 lines)
### Documentation
- Markdown files: 5 guides
- Total documentation: ~1,500+ lines
## Code Organization
### Naming Conventions
- **Classes**: `Informatiq_SP_*` (WordPress style)
- **Functions**: `informatiq_sp_*` prefix
- **Options**: `informatiq_sp_*` prefix
- **Hooks**: `informatiq_sp_*` prefix
- **Text Domain**: `informatiq-smart-pricing`
### Database Tables
- **`{prefix}_informatiq_sp_logs`** - Price update logs
- Columns: id, product_id, product_name, old_price, new_price, competitor_price, message, created_at
- Created on activation
- Dropped on uninstall
### WordPress Options
- `informatiq_sp_merchant_id` - Google Merchant ID
- `informatiq_sp_service_account` - Service Account JSON
- `informatiq_sp_minimum_margin` - Minimum margin %
- `informatiq_sp_auto_update_enabled` - Enable/disable automation
- `informatiq_sp_update_frequency` - Cron frequency
- `informatiq_sp_last_run_start` - Last run start time
- `informatiq_sp_last_run_end` - Last run end time
- `informatiq_sp_last_run_results` - Last run results array
### Cron Events
- **`informatiq_sp_daily_price_update`** - Main cron event
- Frequencies: daily, twice_daily, every_6_hours
- Registered on activation
- Cleared on deactivation
## Key Code Locations
### Main Plugin Initialization
- Plugin bootstrap: `informatiq-smart-google-pricing.php:66`
- Class includes: `informatiq-smart-google-pricing.php:99`
- Activation hook: `informatiq-smart-google-pricing.php:122`
### Google API Integration
- Authentication: `class-informatiq-sp-google-api.php:51`
- Product search: `class-informatiq-sp-google-api.php:108`
- Price fetching: `class-informatiq-sp-google-api.php:143`
### Price Calculation
- Main processor: `class-informatiq-sp-price-updater.php:37`
- Tax calculation: `class-informatiq-sp-price-updater.php:197`
- Minimum price check: `class-informatiq-sp-price-updater.php:230`
### Admin Interface
- Settings page: `class-informatiq-sp-admin.php:84`
- Manual sync: `class-informatiq-sp-admin.php:478`
- AJAX handlers: `class-informatiq-sp-admin.php:478-545`
### Logging
- Database logging: `class-informatiq-sp-logger.php:85`
- WC Logger: `class-informatiq-sp-logger.php:47-82`
- Log retrieval: `class-informatiq-sp-logger.php:120-143`
## Distribution Checklist
When distributing the plugin:
- [ ] Run `./setup-vendor.sh` or `composer install --no-dev`
- [ ] Verify `vendor/google/apiclient/` exists
- [ ] Test activation in WordPress
- [ ] Test connection to Google API
- [ ] Run manual sync to verify functionality
- [ ] Check error logs for any issues
- [ ] Create ZIP with all files including vendor/
- [ ] Document any system requirements
## File Size
**Without vendor directory:**
- ~500 KB (plugin code only)
**With vendor directory:**
- ~10-15 MB uncompressed
- ~2-3 MB when ZIP compressed
This is acceptable for WordPress plugin distribution and eliminates the need for end users to run Composer.
## Version Control
### Included in Git
- All plugin code
- All documentation
- Vendor directory (for distribution)
- composer.json (for development)
### Excluded from Git
- composer.lock
- Development files
- IDE configurations
- OS-specific files (.DS_Store, etc.)
## Support Files
For support and maintenance, check:
- **WooCommerce Logs**: `WooCommerce > Status > Logs`
- **Plugin Logs**: Custom table `wp_informatiq_sp_logs`
- **Cron Status**: Use WP Crontrol plugin to view scheduled events
- **Error Log**: Standard WordPress/PHP error logs
---
**Total Files**: 17 plugin files + vendor dependencies
**Ready for Production**: Yes ✓
**WordPress.org Ready**: Yes (with minor modifications to readme.txt format)

View File

@@ -1,268 +0,0 @@
# Installation & Setup Guide
## Prerequisites
Before installing this plugin, ensure you have:
1. **WordPress** 5.8 or higher
2. **WooCommerce** 5.0 or higher installed and activated
3. **PHP** 7.4 or higher with Composer installed
4. **Google Merchant Center** account with products listed
5. **Google Cloud Project** with Content API for Shopping enabled
## Step 1: Install Plugin Files
### Option A: Complete Package (Recommended)
If you received the plugin with the `vendor/` directory already included:
1. Upload the entire plugin directory to `/wp-content/plugins/`
2. Skip to Step 2 - the plugin is ready to activate!
### Option B: Install Dependencies Manually
If the `vendor/` directory is empty or missing:
1. Upload the plugin files to your WordPress plugins directory:
```bash
cd /wp-content/plugins/
# Upload or clone the plugin files
```
2. Navigate to the plugin directory:
```bash
cd informatiq-smart-google-pricing
```
3. Install dependencies using ONE of these methods:
**Method 1: Using Composer (easiest)**
```bash
composer install --no-dev --optimize-autoloader
```
**Method 2: Manual Download**
- Download Google API PHP Client from: https://github.com/googleapis/google-api-php-client/releases
- Extract to `vendor/google/apiclient/`
- Download dependencies or see `VENDOR-SETUP.md` for detailed instructions
**Note**: The plugin includes a custom autoloader that works with manually placed vendor files, so Composer is optional for end users.
## Step 2: Create Google Service Account
1. **Go to Google Cloud Console**:
- Visit https://console.cloud.google.com/
- Create a new project or select an existing one
2. **Enable Content API for Shopping**:
- Navigate to "APIs & Services" > "Library"
- Search for "Content API for Shopping"
- Click "Enable"
3. **Create Service Account**:
- Go to "APIs & Services" > "Credentials"
- Click "Create Credentials" > "Service Account"
- Fill in the service account details:
- Name: `informatiq-pricing-service`
- Description: `Service account for Smart Pricing plugin`
- Click "Create and Continue"
- Skip optional steps and click "Done"
4. **Create JSON Key**:
- Click on the newly created service account
- Go to the "Keys" tab
- Click "Add Key" > "Create New Key"
- Select "JSON" format
- Click "Create"
- Save the downloaded JSON file securely
5. **Grant Access to Merchant Center**:
- Go to Google Merchant Center (https://merchants.google.com/)
- Navigate to Settings > Users
- Click "Add user"
- Enter the service account email (looks like: `account-name@project-id.iam.gserviceaccount.com`)
- Assign "Admin" or "Standard" access
- Click "Save"
## Step 3: Activate Plugin
1. Log in to your WordPress admin panel
2. Navigate to **Plugins** > **Installed Plugins**
3. Find "informatiq-smart-google-pricing"
4. Click **Activate**
## Step 4: Configure Plugin Settings
1. Navigate to **WooCommerce** > **Smart Pricing**
2. **Configure Google Merchant Center Settings**:
- **Google Merchant ID**: Enter your Merchant Center ID (found in Merchant Center settings)
- **Service Account JSON**: Open the downloaded JSON file and paste its entire contents here
3. **Configure Pricing Settings**:
- **Minimum Margin (%)**: Set your minimum acceptable profit margin (e.g., 10 for 10%)
- This ensures prices never drop below cost + margin
4. **Configure Automation Settings**:
- **Enable Automatic Updates**: Check to enable daily automated updates
- **Update Frequency**: Choose how often to update prices:
- Once Daily (recommended for most stores)
- Twice Daily (for highly competitive markets)
- Every 6 Hours (for very dynamic pricing)
5. Click **Save Settings**
## Step 5: Test Configuration
1. Click the **"Test Google API Connection"** button
2. Wait for the response
3. If successful, you'll see: "Connection successful!"
4. If failed, check your credentials and API access
## Step 6: Run Initial Sync
1. Click the **"Run Manual Sync Now"** button
2. The plugin will:
- Fetch all in-stock products
- Match them with Google Merchant Center
- Retrieve competitive pricing
- Update sale prices according to your rules
3. Review the results in the "Today's Price Updates" section
## Product Requirements
For products to be updated automatically, they must meet these criteria:
1. **Stock Status**: Must be "In Stock"
2. **SKU**: Must have a SKU that matches the product in Google Merchant Center
3. **GTIN** (optional): Can be set via `_gtin` meta field for better matching
4. **Cost** (optional): Set product cost using WooCommerce Cost of Goods plugin for accurate margin calculations
## Setting Product Cost
To use the minimum margin feature effectively:
1. **With Cost of Goods Plugin**:
- Install "WooCommerce Cost of Goods" plugin
- Edit each product
- Enter cost in the "Cost of Goods" field
2. **Without Cost of Goods Plugin**:
- The plugin will use the regular price as a fallback
- This means minimum margin will be calculated from regular price
## Monitoring & Maintenance
### View Logs
- Navigate to **WooCommerce** > **Smart Pricing**
- Scroll to "Today's Price Updates" section
- View detailed logs of all price changes
### Check Schedule
- The "Schedule Information" section shows:
- Next scheduled run time
- Last run time and results
- Number of products processed/updated
### Troubleshooting
If prices aren't updating:
1. **Check WooCommerce Logs**:
- Navigate to **WooCommerce** > **Status** > **Logs**
- Select the `informatiq-smart-pricing-...` log file
- Review error messages
2. **Verify Settings**:
- Ensure Google API credentials are correct
- Test API connection
- Check that automatic updates are enabled
3. **Check Cron**:
- Ensure WordPress cron is running properly
- Install "WP Crontrol" plugin to debug cron jobs
- Look for `informatiq_sp_daily_price_update` event
4. **Product Issues**:
- Verify products have SKUs
- Ensure products are in stock
- Check that products exist in Google Merchant Center
## Advanced Configuration
### Custom Cron Schedule
To change the cron schedule programmatically:
```php
// In your theme's functions.php or custom plugin
Informatiq_SP_Scheduler::reschedule( 'daily' ); // or 'twice_daily', 'every_6_hours'
```
### Hooks and Filters
The plugin provides hooks for customization:
```php
// Modify minimum offset
add_filter( 'informatiq_sp_min_offset', function() {
return 0.10; // Minimum $0.10 difference
});
// Modify maximum offset
add_filter( 'informatiq_sp_max_offset', function() {
return 0.50; // Maximum $0.50 difference
});
```
## Security Recommendations
1. **Protect Service Account JSON**:
- Never commit the JSON key to version control
- Store securely in WordPress database (plugin does this automatically)
- Use environment variables for extra security if needed
2. **Limit Service Account Permissions**:
- Only grant necessary permissions in Merchant Center
- Use "Standard" access if "Admin" isn't required
3. **Regular Audits**:
- Review price change logs regularly
- Monitor for unexpected pricing patterns
- Set up alerts for significant price drops
## Uninstallation
If you need to remove the plugin:
1. Deactivate the plugin from WordPress admin
2. Delete the plugin (this will remove all settings and logs)
3. The plugin automatically:
- Removes all settings from database
- Deletes the custom log table
- Clears scheduled cron events
Note: Product prices will remain at their last updated values. You'll need to manually adjust them if desired.
## Support
For issues or questions:
- Email: contact@malin.ro
- Website: https://informatiq.services
- Documentation: See README.md
## Updates
To update the plugin:
1. Download the latest version
2. Deactivate the old version
3. Replace plugin files
4. Run `composer install` if dependencies changed
5. Reactivate the plugin
Your settings and logs will be preserved during updates.

View File

@@ -1,618 +0,0 @@
# Project Summary: Informatiq Smart Google Pricing Plugin
**Complete WooCommerce plugin for automated competitive pricing based on Google Merchant Center data.**
---
## 🎯 Project Overview
**Plugin Name**: informatiq-smart-google-pricing
**Version**: 1.0.0
**Author**: Mălin Cenușă
**Repository**: https://devops.cloudhost.es/InformatiQ/IQ-Dynamic-Google-Pricing.git
**Status**: ✅ Production Ready
**Total Size**: 224 MB (32,503 files)
---
## 📋 What Was Built
### Core Plugin Components
1. **Main Plugin File** (`informatiq-smart-google-pricing.php`)
- Plugin initialization and bootstrapping
- Activation/deactivation hooks
- WooCommerce dependency checking
- Class loading and instantiation
2. **Google API Integration** (`includes/class-informatiq-sp-google-api.php`)
- Service Account authentication
- Google Content API for Shopping connection
- Product matching via SKU/GTIN
- Competitive price retrieval
- Connection testing
3. **Price Updater** (`includes/class-informatiq-sp-price-updater.php`)
- Tax-aware pricing calculations
- Handles both tax-inclusive and tax-exclusive stores
- Random offset generation (0.05-0.20)
- Minimum margin protection
- WooCommerce Cost of Goods integration
- In-stock product filtering
4. **Scheduler** (`includes/class-informatiq-sp-scheduler.php`)
- WordPress Cron integration
- Daily/twice daily/6-hour schedules
- Automatic price update execution
- Last run tracking
5. **Logger** (`includes/class-informatiq-sp-logger.php`)
- WC_Logger integration
- Custom database table for price logs
- Today's logs retrieval
- Old log cleanup
6. **Admin Interface** (`admin/class-informatiq-sp-admin.php`)
- Settings page under WooCommerce menu
- Google Merchant ID configuration
- Service Account JSON input
- Minimum margin settings
- Automation controls
- Manual sync button
- Test connection button
- Log viewer
7. **Assets**
- `assets/css/admin.css` - Responsive admin styling
- `assets/js/admin.js` - AJAX handlers for manual sync
8. **Uninstaller** (`uninstall.php`)
- Clean removal of all plugin data
- Database table deletion
- Option cleanup
- Cron event clearing
---
## 🔑 Key Features Implemented
### ✅ Automation
- Daily automated price updates via WP Cron
- Only processes in-stock products
- Configurable update frequency (daily, twice daily, 6-hour)
- Last run tracking and statistics
### ✅ Google Merchant Center Integration
- Service Account authentication (JSON key)
- SKU and GTIN product matching
- Competitive pricing data retrieval
- Connection testing
### ✅ Intelligent Pricing Logic
- **Goal**: Make final price (tax included) lower than competitor by $0.05-$0.20
- Random offset generation for natural pricing
- Tax-aware calculations:
- If `wc_prices_include_tax()` is true: Direct price setting
- If false: Reverse-calculates base price for correct final price
- Minimum margin protection (never sell below cost + margin %)
- Uses `_wc_cog_cost` meta or falls back to regular price
### ✅ Safeguards
- Minimum margin enforcement
- Cost-based pricing floor
- Error handling and logging
- Transaction safety
### ✅ Admin Interface
- Clean settings page under WooCommerce
- Google Merchant ID input
- Service Account JSON textarea
- Minimum margin % configuration
- Auto-update enable/disable
- Manual sync button with AJAX feedback
- Test connection feature
- Today's price updates log view
- Schedule information display
### ✅ Logging & Debugging
- Custom database table: `wp_informatiq_sp_logs`
- WooCommerce logger integration
- Product-level change tracking
- Error logging
---
## 📦 Repository Contents
### Production Files in Git
```
informatiq-smart-google-pricing/
├── admin/
│ └── class-informatiq-sp-admin.php (Admin interface)
├── assets/
│ ├── css/
│ │ └── admin.css (Admin styling)
│ └── js/
│ └── admin.js (AJAX handlers)
├── includes/
│ ├── class-informatiq-sp-google-api.php (Google API integration)
│ ├── class-informatiq-sp-logger.php (Logging system)
│ ├── class-informatiq-sp-price-updater.php (Pricing logic)
│ └── class-informatiq-sp-scheduler.php (Cron scheduler)
├── languages/
│ └── informatiq-smart-pricing.pot (Translation template)
├── vendor/ (32,472 files)
│ ├── google/apiclient/ (Google API Client v2.18.4)
│ ├── google/apiclient-services/ (v0.425.0)
│ ├── guzzlehttp/ (HTTP client)
│ ├── firebase/php-jwt/ (JWT handling)
│ ├── psr/ (PSR standards)
│ └── ...all dependencies
├── informatiq-smart-google-pricing.php (Main plugin file)
├── uninstall.php (Uninstall cleanup)
├── .gitignore (Git ignore rules)
├── FILE-MANIFEST.md (File reference)
├── INSTALLATION.md (Setup guide)
├── QUICKSTART.md (Quick start guide)
└── README.md (Complete documentation)
```
### Files Excluded from Git (Development Only)
These files exist locally but are NOT in the repository:
```
composer.json (Composer configuration)
composer.lock (Dependency lock file)
setup-vendor.sh (Linux setup script)
setup-vendor.bat (Windows setup script)
VENDOR-SETUP.md (Vendor setup guide)
```
---
## 🚀 Installation Instructions
### For End Users
1. **Clone the repository**:
```bash
git clone https://devops.cloudhost.es/InformatiQ/IQ-Dynamic-Google-Pricing.git
```
2. **Upload to WordPress**:
```bash
cp -r IQ-Dynamic-Google-Pricing /path/to/wordpress/wp-content/plugins/informatiq-smart-google-pricing
```
3. **Activate the plugin**:
- Go to WordPress Admin > Plugins
- Find "informatiq-smart-google-pricing"
- Click "Activate"
4. **Configure settings**:
- Navigate to WooCommerce > Smart Pricing
- Enter Google Merchant ID
- Paste Service Account JSON key
- Set minimum margin (e.g., 10%)
- Enable automatic updates
- Test connection
- Run manual sync
**That's it!** The plugin is ready to use.
---
## ⚙️ Configuration Requirements
### Google Merchant Center Setup
1. **Create Google Cloud Project**:
- Go to https://console.cloud.google.com/
- Create new project or select existing
2. **Enable Content API for Shopping**:
- Navigate to "APIs & Services" > "Library"
- Search for "Content API for Shopping"
- Click "Enable"
3. **Create Service Account**:
- Go to "APIs & Services" > "Credentials"
- Click "Create Credentials" > "Service Account"
- Name: `informatiq-pricing-service`
- Create and download JSON key
4. **Grant Access to Merchant Center**:
- Go to https://merchants.google.com/
- Settings > Users
- Add service account email
- Grant "Admin" or "Standard" access
### WordPress/WooCommerce Requirements
- WordPress 5.8+
- WooCommerce 5.0+
- PHP 7.4+
- Products must:
- Be in stock
- Have SKU set
- Exist in Google Merchant Center
### Optional (Recommended)
- **WooCommerce Cost of Goods** plugin for accurate cost tracking
- Products should have `_wc_cog_cost` meta set
---
## 🔧 Technical Architecture
### Database Schema
**Custom Table**: `{prefix}_informatiq_sp_logs`
```sql
CREATE TABLE wp_informatiq_sp_logs (
id bigint(20) UNSIGNED AUTO_INCREMENT PRIMARY KEY,
product_id bigint(20) UNSIGNED NOT NULL,
product_name varchar(255) NOT NULL,
old_price decimal(10,2) DEFAULT NULL,
new_price decimal(10,2) NOT NULL,
competitor_price decimal(10,2) NOT NULL,
message text,
created_at datetime DEFAULT CURRENT_TIMESTAMP,
KEY product_id (product_id),
KEY created_at (created_at)
);
```
### WordPress Options
```php
informatiq_sp_merchant_id // Google Merchant ID
informatiq_sp_service_account // Service Account JSON
informatiq_sp_minimum_margin // Minimum margin %
informatiq_sp_auto_update_enabled // 1 or 0
informatiq_sp_update_frequency // daily, twice_daily, every_6_hours
informatiq_sp_last_run_start // Last run start time
informatiq_sp_last_run_end // Last run end time
informatiq_sp_last_run_results // Array of last run stats
```
### Cron Events
**Event**: `informatiq_sp_daily_price_update`
- Registered on plugin activation
- Cleared on plugin deactivation
- Frequency: Configurable (daily, twice_daily, every_6_hours)
### Hooks & Filters
The plugin uses standard WordPress hooks:
- `plugins_loaded` - Load text domain
- `admin_menu` - Add admin menu
- `admin_init` - Register settings
- `admin_enqueue_scripts` - Enqueue assets
- `wp_ajax_informatiq_sp_manual_sync` - Manual sync handler
- `wp_ajax_informatiq_sp_test_connection` - Test connection handler
---
## 💡 How the Pricing Algorithm Works
### Step-by-Step Process
1. **Product Selection**:
- Query all products with `stock_status = 'instock'`
- Filter by product type: simple and variable
2. **Google Merchant Lookup**:
- Match by SKU (primary)
- Match by GTIN (secondary, if available)
- Retrieve competitor price from Google
3. **Random Offset Generation**:
```php
$offset = rand(5, 20) / 100; // 0.05 to 0.20
```
4. **Target Price Calculation**:
```php
$target_price = $competitor_price - $offset;
```
5. **Tax Handling**:
- **If prices include tax**:
```php
$new_price = $target_price;
```
- **If prices exclude tax**:
```php
$tax_rate = get_tax_rate($product);
$new_price = $target_price / (1 + $tax_rate/100);
```
6. **Minimum Price Check**:
```php
$cost = get_post_meta($product_id, '_wc_cog_cost', true);
if (!$cost) $cost = $product->get_regular_price();
$minimum_price = $cost * (1 + $margin_percent/100);
if ($new_price < $minimum_price) {
$new_price = $minimum_price;
}
```
7. **Price Update**:
```php
$product->set_sale_price($new_price);
$product->save();
```
8. **Logging**:
- Log to custom table
- Log to WooCommerce logger
- Track old price, new price, competitor price
---
## 📊 Code Statistics
**Total Files**: 32,503
**Total Lines**: 4,065,017
**Plugin Code Only**: ~2,500 lines
**Documentation**: ~1,500 lines
**Breakdown**:
- PHP Classes: 7 files
- Assets: 2 files (CSS + JS)
- Documentation: 4 files
- Vendor Dependencies: 32,472 files
---
## 🔐 Security Features
1. **Nonce Verification**: All AJAX requests use WordPress nonces
2. **Capability Checks**: Admin actions require `manage_woocommerce` capability
3. **SQL Injection Prevention**: All queries use `$wpdb->prepare()`
4. **XSS Protection**: All output escaped with `esc_html()`, `esc_attr()`, etc.
5. **Service Account Security**: JSON key stored in WordPress options (not version control)
6. **Input Sanitization**: All user input sanitized before storage
---
## 🧪 Testing Checklist
Before deploying to production:
- [ ] Test API connection with real credentials
- [ ] Run manual sync with test products
- [ ] Verify tax calculations (both inclusive and exclusive)
- [ ] Check minimum margin enforcement
- [ ] Test with products missing SKU
- [ ] Test with products not in Merchant Center
- [ ] Verify cron schedule is created
- [ ] Check logs are being written
- [ ] Test admin interface responsiveness
- [ ] Verify uninstall cleanup
---
## 🐛 Troubleshooting
### Common Issues
**"Google API Client library is missing"**
- Solution: Vendor directory not included. Clone from Git repository which includes all dependencies.
**"Connection failed"**
- Check: Merchant ID is correct
- Check: Service Account JSON is valid
- Check: Service account has access to Merchant Center
- Check: Content API for Shopping is enabled
**"No competitor price found"**
- Check: Product exists in Google Merchant Center
- Check: SKU matches between WooCommerce and Merchant Center
- Check: Product has competitive data available
**Prices not updating automatically**
- Check: "Enable Automatic Updates" is checked
- Check: WordPress cron is running (test with WP Crontrol plugin)
- Check: Look for `informatiq_sp_daily_price_update` cron event
**Prices going too low**
- Check: Minimum margin is set appropriately
- Check: Product cost is set (via Cost of Goods or regular price)
- Check: Logs to see if minimum price is being enforced
### Debug Logging
**View WooCommerce Logs**:
1. Go to WooCommerce > Status > Logs
2. Select log file starting with `informatiq-smart-pricing-`
3. Review errors and warnings
**View Custom Logs**:
1. Go to WooCommerce > Smart Pricing
2. Scroll to "Today's Price Updates"
3. View detailed price change logs
---
## 📚 Documentation Files
All documentation is included in the repository:
1. **README.md** - Complete plugin overview and features
2. **INSTALLATION.md** - Detailed setup and configuration guide
3. **QUICKSTART.md** - 10-minute quick start guide
4. **FILE-MANIFEST.md** - Complete file structure reference
5. **PROJECT-SUMMARY.md** - This file (comprehensive project documentation)
---
## 🔄 Version Control
**Repository**: https://devops.cloudhost.es/InformatiQ/IQ-Dynamic-Google-Pricing.git
**Branch**: main
**Latest Commit**: "Remove development files from repository - keep only production plugin files"
### Git Credentials (for future reference)
- Username: `Malin`
- Password: `MuieSteaua09!@`
- URL format: `https://Malin:MuieSteaua09%21%40@devops.cloudhost.es/InformatiQ/IQ-Dynamic-Google-Pricing.git`
### Cloning the Repository
```bash
git clone https://devops.cloudhost.es/InformatiQ/IQ-Dynamic-Google-Pricing.git
```
---
## 🎨 Customization Options
### Modify Price Offset Range
Edit `includes/class-informatiq-sp-price-updater.php`:
```php
// Current: 0.05 to 0.20
private $min_offset = 0.05;
private $max_offset = 0.20;
// Change to: 0.10 to 0.50
private $min_offset = 0.10;
private $max_offset = 0.50;
```
### Add Custom Product Filters
In `get_instock_products()` method:
```php
$args = array(
'status' => 'publish',
'stock_status' => 'instock',
'limit' => -1,
'return' => 'objects',
'type' => array( 'simple', 'variable' ),
// Add custom meta query:
'meta_query' => array(
array(
'key' => 'custom_field',
'value' => 'custom_value',
'compare' => '=',
),
),
);
```
### Modify Cron Schedule
Add custom schedules in `class-informatiq-sp-scheduler.php`:
```php
$schedules['every_3_hours'] = array(
'interval' => 3 * HOUR_IN_SECONDS,
'display' => __( 'Every 3 Hours', 'informatiq-smart-pricing' ),
);
```
---
## 📞 Support Information
**Author**: Mălin Cenușă
**Email**: contact@malin.ro
**Website**: https://informatiq.services
**Company**: https://malin.ro
---
## 📄 License
GPL v2 or later
This plugin is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or any later version.
---
## ✅ Project Status
**Status**: ✅ **COMPLETE AND PRODUCTION READY**
### What's Working
- ✅ Google Merchant Center API integration
- ✅ Service Account authentication
- ✅ Product matching via SKU/GTIN
- ✅ Competitive price retrieval
- ✅ Tax-aware pricing calculations
- ✅ Minimum margin protection
- ✅ WP Cron automation
- ✅ Admin interface with all features
- ✅ Manual sync functionality
- ✅ Connection testing
- ✅ Comprehensive logging
- ✅ Database table creation
- ✅ Clean uninstall
- ✅ Full documentation
- ✅ Vendor dependencies included
- ✅ Git repository configured
### Ready For
- ✅ Client delivery
- ✅ Production deployment
- ✅ WordPress.org submission (with minor readme.txt formatting)
- ✅ Commercial distribution
---
## 🎯 Next Steps (Optional Enhancements)
While the plugin is complete, here are potential future enhancements:
1. **Bulk Actions**: Add bulk price update from product list
2. **Price History**: Track historical price changes over time
3. **Email Notifications**: Alert when prices change significantly
4. **Product Categories**: Filter which categories to auto-price
5. **Competitor Tracking**: Track multiple competitors separately
6. **Price Rules**: Advanced rules (e.g., weekday pricing)
7. **Analytics Dashboard**: Visual charts of price changes
8. **API Endpoint**: REST API for external access
9. **Multi-Currency**: Support for multi-currency stores
10. **A/B Testing**: Test different pricing strategies
---
## 📝 Final Notes
This plugin represents a complete, production-ready solution for automated competitive pricing in WooCommerce stores using Google Merchant Center data.
**Key Achievements**:
- Clean, object-oriented code
- WordPress coding standards
- Comprehensive error handling
- Extensive documentation
- Ready-to-deploy package
- No Composer required for end users
- Professional admin interface
- Enterprise-grade logging
**Installation Time**: < 5 minutes
**Configuration Time**: ~10 minutes
**Time to First Price Update**: Immediate (via manual sync) or next scheduled run
---
**End of Project Summary**
Generated: 2024-12-29
Plugin Version: 1.0.0
Total Development Time: ~4 hours
Lines of Code (plugin only): ~2,500
Lines of Code (with dependencies): 4,065,017

View File

@@ -1,141 +0,0 @@
# Quick Reference Card
## Repository Access
```bash
git clone https://devops.cloudhost.es/InformatiQ/IQ-Dynamic-Google-Pricing.git
```
**Credentials**:
- Username: `Malin`
- Password: `MuieSteaua09!@`
---
## Installation (3 Steps)
1. **Clone & Upload**:
```bash
git clone https://devops.cloudhost.es/InformatiQ/IQ-Dynamic-Google-Pricing.git
cp -r IQ-Dynamic-Google-Pricing /path/to/wordpress/wp-content/plugins/informatiq-smart-google-pricing
```
2. **Activate**: WordPress Admin > Plugins > Activate "informatiq-smart-google-pricing"
3. **Configure**: WooCommerce > Smart Pricing
- Enter Google Merchant ID
- Paste Service Account JSON
- Set minimum margin %
- Enable auto-updates
- Test connection
- Run manual sync
---
## Key File Locations
**Main Plugin**: `informatiq-smart-google-pricing.php`
**Admin Interface**: `admin/class-informatiq-sp-admin.php`
**Google API**: `includes/class-informatiq-sp-google-api.php`
**Price Logic**: `includes/class-informatiq-sp-price-updater.php`
**Scheduler**: `includes/class-informatiq-sp-scheduler.php`
**Logger**: `includes/class-informatiq-sp-logger.php`
---
## Database
**Table**: `wp_informatiq_sp_logs`
**Options**:
- `informatiq_sp_merchant_id`
- `informatiq_sp_service_account`
- `informatiq_sp_minimum_margin`
- `informatiq_sp_auto_update_enabled`
- `informatiq_sp_update_frequency`
**Cron Event**: `informatiq_sp_daily_price_update`
---
## Admin Access
**Settings Page**: WooCommerce > Smart Pricing
**Logs**: WooCommerce > Status > Logs (select informatiq-smart-pricing log)
**Cron Check**: Install "WP Crontrol" plugin to view scheduled events
---
## Pricing Formula
```
1. Get competitor price from Google Merchant Center
2. Generate random offset: $0.05 - $0.20
3. Calculate target: Competitor Price - Offset
4. Handle taxes (inclusive or exclusive)
5. Check minimum: Cost + Margin %
6. Update sale price
7. Log change
```
---
## Product Requirements
- ✅ Stock status: In stock
- ✅ SKU: Must be set and match Google Merchant Center
- ✅ Exist in Google Merchant Center
- ⭐ Optional: `_wc_cog_cost` meta for accurate margins
---
## Troubleshooting Quick Fixes
**"Connection failed"**
→ Check Merchant ID, Service Account JSON, API enabled
**"No competitive data"**
→ Product not in Merchant Center or SKU mismatch
**"Prices not updating"**
→ Check WP Cron is running, auto-updates enabled
**"Library missing"**
→ Clone from Git (vendor included)
---
## Key Features
✅ Automated daily price updates
✅ Tax-aware calculations
✅ Minimum margin protection
✅ Google Merchant Center integration
✅ Manual sync button
✅ Comprehensive logging
✅ Clean admin interface
✅ In-stock only processing
---
## Support
**Author**: Mălin Cenușă
**Email**: contact@malin.ro
**Website**: https://informatiq.services
---
## Documentation Files
- `README.md` - Full documentation
- `INSTALLATION.md` - Detailed setup guide
- `QUICKSTART.md` - 10-minute guide
- `PROJECT-SUMMARY.md` - Complete project overview
- `FILE-MANIFEST.md` - File reference
- `QUICK-REFERENCE.md` - This file
---
**Version**: 1.0.0
**Status**: ✅ Production Ready
**Size**: 224 MB (32,503 files)
**Plugin Code**: ~2,500 lines

View File

@@ -1,167 +0,0 @@
# Quick Start Guide
Get the plugin running in under 10 minutes!
## For Developers/Distributors
### 1. Install Google API Client Library
Choose the easiest method for you:
**Option A: One-command setup (Recommended)**
```bash
cd /path/to/informatiq-smart-google-pricing
./setup-vendor.sh
```
**Option B: Manual Composer**
```bash
cd /path/to/informatiq-smart-google-pricing
composer install --no-dev --optimize-autoloader
```
**Option C: Already have vendor?**
If you already ran Composer or have the vendor directory, skip this step!
### 2. Distribute
Now you can:
- ZIP the entire plugin directory (including `vendor/`)
- Upload to WordPress
- Share with clients
- No Composer required for end users!
The complete package will be ~2-3 MB (compressed) or ~10-15 MB (uncompressed).
---
## For End Users (Installing the Plugin)
### 1. Upload Plugin
- Upload the complete plugin folder to `/wp-content/plugins/`
- Or use WordPress admin: Plugins > Add New > Upload Plugin
### 2. Activate
- Go to Plugins in WordPress admin
- Find "informatiq-smart-google-pricing"
- Click "Activate"
### 3. Configure Google Merchant Center
You need:
- Google Merchant Center account with products
- Google Service Account JSON key
**Don't have these yet?** See `INSTALLATION.md` for detailed setup instructions.
### 4. Enter Settings
Navigate to **WooCommerce > Smart Pricing**
**Required Settings:**
- **Google Merchant ID**: Your Merchant Center ID
- **Service Account JSON**: Paste the entire JSON key
- **Minimum Margin**: Set your desired profit margin (e.g., 10%)
**Optional Settings:**
- **Enable Automatic Updates**: Check to enable daily automation
- **Update Frequency**: How often to update prices
### 5. Test Connection
- Click "Test Google API Connection" button
- Wait for success message
- If it fails, double-check your credentials
### 6. Run First Sync
- Click "Run Manual Sync Now" button
- Watch the progress
- Review updated prices in the logs below
### 7. Done!
The plugin will now:
- Run automatically based on your schedule
- Only update in-stock products
- Never sell below your minimum margin
- Log all price changes for review
---
## Troubleshooting
### "Google API Client library is missing"
The vendor directory wasn't included. Either:
1. Download the complete package with vendor included
2. Run `composer install` in plugin directory
3. See `VENDOR-SETUP.md` for manual download instructions
### "Connection failed"
Check:
- Merchant ID is correct (numbers only)
- Service Account JSON is valid (should start with `{`)
- Service account has access to your Merchant Center
- Content API for Shopping is enabled in Google Cloud
### "No competitor price found"
This means:
- Product doesn't exist in Google Merchant Center, OR
- Product SKU doesn't match, OR
- No competitive pricing data available for that product
Ensure products have matching SKUs between WooCommerce and Google Merchant Center.
### Prices not updating automatically
Check:
- "Enable Automatic Updates" is checked in settings
- WordPress cron is running (install WP Crontrol plugin to verify)
- Look for `informatiq_sp_daily_price_update` cron event
---
## Next Steps
### Optimize Your Pricing Strategy
1. **Set Product Costs**: Use WooCommerce Cost of Goods plugin
- This allows accurate margin calculations
- Prevents selling below cost
2. **Monitor Logs**: Check daily updates
- WooCommerce > Smart Pricing > Today's Price Updates
- Review which products are being updated
3. **Adjust Settings**: Fine-tune based on results
- Increase minimum margin if needed
- Change update frequency for competitive markets
4. **Review WooCommerce Logs**: For debugging
- WooCommerce > Status > Logs
- Look for `informatiq-smart-pricing` logs
### Advanced Features
See `INSTALLATION.md` for:
- Custom cron schedules
- Hooks and filters for customization
- Security best practices
- Detailed troubleshooting
---
## Support
Need help?
- Email: contact@malin.ro
- Website: https://informatiq.services
---
**That's it! Your automated competitive pricing is now live.** 🎉

View File

@@ -4,12 +4,13 @@ A production-ready WooCommerce plugin that automatically adjusts sale prices bas
## Description ## Description
This plugin connects to Google Merchant Center API to retrieve competitive pricing data and automatically updates your WooCommerce product prices to stay competitive while maintaining your desired profit margins. This plugin connects to the Google Merchant API to retrieve competitive pricing data and automatically updates your WooCommerce product prices to stay competitive while maintaining your desired profit margins.
## Features ## Features
- **Automated Daily Price Updates**: Schedule automatic price adjustments using WordPress cron - **Automated Daily Price Updates**: Schedule automatic price adjustments using WordPress cron
- **Google Merchant Center Integration**: Connects via Google Content API for Shopping - **Google Merchant API Integration**: Uses the new Google Merchant API (replaces deprecated Content API)
- **No External Dependencies**: Self-contained plugin with no Composer requirements
- **Tax-Aware Pricing**: Handles both tax-inclusive and tax-exclusive pricing configurations - **Tax-Aware Pricing**: Handles both tax-inclusive and tax-exclusive pricing configurations
- **Minimum Margin Protection**: Never sell below your cost + minimum margin - **Minimum Margin Protection**: Never sell below your cost + minimum margin
- **In-Stock Only Processing**: Only updates products that are currently in stock - **In-Stock Only Processing**: Only updates products that are currently in stock
@@ -22,35 +23,25 @@ This plugin connects to Google Merchant Center API to retrieve competitive prici
- WordPress 5.8 or higher - WordPress 5.8 or higher
- WooCommerce 5.0 or higher - WooCommerce 5.0 or higher
- PHP 7.4 or higher - PHP 7.4 or higher
- PHP OpenSSL extension (for JWT authentication)
- Google Merchant Center account - Google Merchant Center account
- Google Service Account with Content API access - Google Service Account with Merchant API access
## Installation ## Installation
### Quick Install (Recommended) 1. Download the plugin
1. Download the plugin with vendor libraries included (complete package)
2. Upload to `/wp-content/plugins/informatiq-smart-google-pricing/` 2. Upload to `/wp-content/plugins/informatiq-smart-google-pricing/`
3. Activate the plugin through the 'Plugins' menu in WordPress 3. Activate the plugin through the 'Plugins' menu in WordPress
4. Configure settings under WooCommerce > Smart Pricing 4. Configure settings under WooCommerce > Smart Pricing
### Manual Setup (If vendor directory is missing) No Composer or external dependencies required - the plugin is fully self-contained.
1. Upload the plugin files to `/wp-content/plugins/informatiq-smart-google-pricing/`
2. Set up Google API Client library (see `VENDOR-SETUP.md` for details):
- **Option A**: Run `composer install` in the plugin directory
- **Option B**: Manually download and extract Google API Client to `vendor/` directory
3. Activate the plugin through the 'Plugins' menu in WordPress
4. Configure settings under WooCommerce > Smart Pricing
The plugin includes a custom autoloader that works with manually included libraries, so Composer is not required for end users.
## Configuration ## Configuration
### Google Merchant Center Setup ### Google Merchant Center Setup
1. Create a Google Cloud Project 1. Create a Google Cloud Project
2. Enable the Content API for Shopping 2. Enable the Merchant API
3. Create a Service Account and download the JSON key 3. Create a Service Account and download the JSON key
4. Grant the service account access to your Merchant Center account 4. Grant the service account access to your Merchant Center account
@@ -67,7 +58,7 @@ The plugin includes a custom autoloader that works with manually included librar
1. **Daily Automation**: The plugin runs automatically based on your configured schedule 1. **Daily Automation**: The plugin runs automatically based on your configured schedule
2. **Product Matching**: Matches WooCommerce products with Google Merchant Center via SKU/GTIN 2. **Product Matching**: Matches WooCommerce products with Google Merchant Center via SKU/GTIN
3. **Competitive Analysis**: Retrieves the lowest competitor price from Google 3. **Competitive Analysis**: Retrieves competitive pricing data from Google's Price Competitiveness reports
4. **Price Calculation**: 4. **Price Calculation**:
- Calculates new price as: Competitor Price - Random Offset (0.05-0.20) - Calculates new price as: Competitor Price - Random Offset (0.05-0.20)
- Ensures price never goes below Cost + Minimum Margin - Ensures price never goes below Cost + Minimum Margin
@@ -123,9 +114,7 @@ The plugin supports multiple update frequencies:
- Twice daily (every 12 hours) - Twice daily (every 12 hours)
- Every 6 hours - Every 6 hours
## Development ## File Structure
### File Structure
``` ```
informatiq-smart-google-pricing/ informatiq-smart-google-pricing/
@@ -141,22 +130,19 @@ informatiq-smart-google-pricing/
│ ├── class-informatiq-sp-logger.php │ ├── class-informatiq-sp-logger.php
│ ├── class-informatiq-sp-price-updater.php │ ├── class-informatiq-sp-price-updater.php
│ └── class-informatiq-sp-scheduler.php │ └── class-informatiq-sp-scheduler.php
├── composer.json ├── languages/
├── informatiq-smart-google-pricing.php ├── informatiq-smart-google-pricing.php
├── README.md ├── README.md
└── uninstall.php └── uninstall.php
``` ```
### Dependencies ## API Notes
The plugin uses Composer for dependency management: This plugin uses the new Google Merchant API which replaces the deprecated Content API for Shopping. Key differences:
```bash - **Base URL**: `https://merchantapi.googleapis.com`
composer install - **Pricing**: Amounts are in micros (1,000,000 micros = 1 unit of currency)
``` - **Resource naming**: Uses hierarchical names like `accounts/{id}/products/{product}`
Main dependencies:
- `google/apiclient`: ^2.15
## Support ## Support
@@ -174,6 +160,12 @@ GPL v2 or later
## Changelog ## Changelog
### 2.0.0
- Migrated to Google Merchant API (from deprecated Content API)
- Removed Composer/vendor dependencies
- Self-contained plugin with direct REST API calls
- JWT-based authentication using PHP OpenSSL
### 1.0.0 ### 1.0.0
- Initial release - Initial release
- Google Merchant Center integration - Google Merchant Center integration

View File

@@ -1,6 +1,9 @@
<?php <?php
/** /**
* Google Merchant Center API integration. * Google Merchant API integration using direct REST calls.
*
* This class implements authentication and API calls to the new Google Merchant API
* without requiring Composer or external dependencies.
* *
* @package InformatiqSmartPricing * @package InformatiqSmartPricing
*/ */
@@ -11,30 +14,58 @@ if ( ! defined( 'ABSPATH' ) ) {
} }
/** /**
* Google API class. * Google Merchant API class.
*/ */
class Informatiq_SP_Google_API { class Informatiq_SP_Google_API {
/** /**
* Google Client instance. * Merchant API base URL.
* *
* @var Google_Client * @var string
*/ */
private $client; const API_BASE_URL = 'https://merchantapi.googleapis.com';
/** /**
* Google Shopping Content service. * OAuth token endpoint.
* *
* @var Google_Service_ShoppingContent * @var string
*/ */
private $service; const TOKEN_URL = 'https://oauth2.googleapis.com/token';
/** /**
* Merchant ID. * API scope for Merchant Center.
*
* @var string
*/
const API_SCOPE = 'https://www.googleapis.com/auth/content';
/**
* Access token.
*
* @var string
*/
private $access_token;
/**
* Token expiration time.
*
* @var int
*/
private $token_expires;
/**
* Merchant ID (account ID).
* *
* @var string * @var string
*/ */
private $merchant_id; private $merchant_id;
/**
* Service account credentials.
*
* @var array
*/
private $credentials;
/** /**
* Logger instance. * Logger instance.
* *
@@ -54,36 +85,165 @@ class Informatiq_SP_Google_API {
$this->merchant_id = $merchant_id; $this->merchant_id = $merchant_id;
$this->logger = $logger; $this->logger = $logger;
try { // Parse service account JSON.
$this->authenticate( $service_account ); $this->credentials = json_decode( $service_account, true );
} catch ( Exception $e ) {
$this->logger->error( 'Google API authentication failed: ' . $e->getMessage() );
throw $e;
}
}
/**
* Authenticate with Google API.
*
* @param string $service_account Service account JSON.
* @throws Exception If authentication fails.
*/
private function authenticate( $service_account ) {
// Decode service account JSON.
$credentials = json_decode( $service_account, true );
if ( json_last_error() !== JSON_ERROR_NONE ) { if ( json_last_error() !== JSON_ERROR_NONE ) {
throw new Exception( 'Invalid service account JSON: ' . json_last_error_msg() ); throw new Exception( 'Invalid service account JSON: ' . json_last_error_msg() );
} }
// Initialize Google Client. if ( empty( $this->credentials['client_email'] ) || empty( $this->credentials['private_key'] ) ) {
$this->client = new Google_Client(); throw new Exception( 'Service account JSON must contain client_email and private_key' );
$this->client->setApplicationName( 'Informatiq Smart Pricing' ); }
$this->client->setScopes( array( 'https://www.googleapis.com/auth/content' ) ); }
$this->client->setAuthConfig( $credentials );
// Initialize Shopping Content service. /**
$this->service = new Google_Service_ShoppingContent( $this->client ); * Get access token, refreshing if necessary.
*
* @return string Access token.
* @throws Exception If token retrieval fails.
*/
private function get_access_token() {
// Return cached token if still valid (with 60 second buffer).
if ( $this->access_token && $this->token_expires > ( time() + 60 ) ) {
return $this->access_token;
}
// Create JWT for token exchange.
$jwt = $this->create_jwt();
// Exchange JWT for access token.
$response = wp_remote_post(
self::TOKEN_URL,
array(
'body' => array(
'grant_type' => 'urn:ietf:params:oauth:grant-type:jwt-bearer',
'assertion' => $jwt,
),
'timeout' => 30,
)
);
if ( is_wp_error( $response ) ) {
throw new Exception( 'Token request failed: ' . $response->get_error_message() );
}
$body = json_decode( wp_remote_retrieve_body( $response ), true );
if ( isset( $body['error'] ) ) {
throw new Exception( 'Token error: ' . ( $body['error_description'] ?? $body['error'] ) );
}
if ( empty( $body['access_token'] ) ) {
throw new Exception( 'No access token in response' );
}
$this->access_token = $body['access_token'];
$this->token_expires = time() + ( $body['expires_in'] ?? 3600 );
return $this->access_token;
}
/**
* Create a signed JWT for authentication.
*
* @return string Signed JWT.
* @throws Exception If JWT creation fails.
*/
private function create_jwt() {
$now = time();
// JWT Header.
$header = array(
'alg' => 'RS256',
'typ' => 'JWT',
);
// JWT Claims.
$claims = array(
'iss' => $this->credentials['client_email'],
'scope' => self::API_SCOPE,
'aud' => self::TOKEN_URL,
'iat' => $now,
'exp' => $now + 3600,
);
// Encode header and claims.
$header_encoded = $this->base64url_encode( wp_json_encode( $header ) );
$claims_encoded = $this->base64url_encode( wp_json_encode( $claims ) );
// Create signature input.
$signature_input = $header_encoded . '.' . $claims_encoded;
// Sign with private key.
$private_key = openssl_pkey_get_private( $this->credentials['private_key'] );
if ( ! $private_key ) {
throw new Exception( 'Invalid private key in service account' );
}
$signature = '';
$success = openssl_sign( $signature_input, $signature, $private_key, OPENSSL_ALGO_SHA256 );
if ( ! $success ) {
throw new Exception( 'Failed to sign JWT' );
}
// Return complete JWT.
return $signature_input . '.' . $this->base64url_encode( $signature );
}
/**
* Base64url encode (URL-safe base64).
*
* @param string $data Data to encode.
* @return string Encoded data.
*/
private function base64url_encode( $data ) {
return rtrim( strtr( base64_encode( $data ), '+/', '-_' ), '=' );
}
/**
* Make an API request to the Merchant API.
*
* @param string $method HTTP method (GET, POST, etc.).
* @param string $endpoint API endpoint (relative to base URL).
* @param array $data Request data for POST/PUT requests.
* @return array Response data.
* @throws Exception If request fails.
*/
private function api_request( $method, $endpoint, $data = array() ) {
$token = $this->get_access_token();
$args = array(
'method' => $method,
'headers' => array(
'Authorization' => 'Bearer ' . $token,
'Content-Type' => 'application/json',
),
'timeout' => 60,
);
if ( ! empty( $data ) && in_array( $method, array( 'POST', 'PUT', 'PATCH' ), true ) ) {
$args['body'] = wp_json_encode( $data );
}
$url = self::API_BASE_URL . $endpoint;
$response = wp_remote_request( $url, $args );
if ( is_wp_error( $response ) ) {
throw new Exception( 'API request failed: ' . $response->get_error_message() );
}
$status_code = wp_remote_retrieve_response_code( $response );
$body = json_decode( wp_remote_retrieve_body( $response ), true );
if ( $status_code >= 400 ) {
$error_message = isset( $body['error']['message'] ) ? $body['error']['message'] : 'Unknown error';
throw new Exception( "API error ($status_code): $error_message" );
}
return $body ?? array();
} }
/** /**
@@ -96,17 +256,28 @@ class Informatiq_SP_Google_API {
public function get_competitive_price( $sku, $gtin = '' ) { public function get_competitive_price( $sku, $gtin = '' ) {
try { try {
// Search for the product using SKU or GTIN. // Search for the product using SKU or GTIN.
$product_id = $this->find_product_by_identifier( $sku, $gtin ); $product = $this->find_product_by_identifier( $sku, $gtin );
if ( ! $product_id ) { if ( ! $product ) {
$this->logger->warning( "Product not found in Google Merchant Center: SKU={$sku}, GTIN={$gtin}" ); $this->logger->warning( "Product not found in Google Merchant Center: SKU={$sku}, GTIN={$gtin}" );
return null; return null;
} }
// Get competitive pricing data. // Try to get competitive pricing data from reports.
$competitive_price = $this->fetch_competitive_price( $product_id ); $competitive_price = $this->fetch_competitive_price_from_reports( $sku, $gtin );
return $competitive_price; if ( $competitive_price ) {
return $competitive_price;
}
// Fallback: Use product's own price as reference.
if ( isset( $product['price']['amountMicros'] ) ) {
$price = (float) $product['price']['amountMicros'] / 1000000;
$this->logger->warning( "No competitive data available for SKU={$sku}, using own price as reference" );
return $price;
}
return null;
} catch ( Exception $e ) { } catch ( Exception $e ) {
$this->logger->error( 'Error fetching competitive price: ' . $e->getMessage() ); $this->logger->error( 'Error fetching competitive price: ' . $e->getMessage() );
@@ -119,31 +290,39 @@ class Informatiq_SP_Google_API {
* *
* @param string $sku Product SKU. * @param string $sku Product SKU.
* @param string $gtin Product GTIN. * @param string $gtin Product GTIN.
* @return string|null Product ID or null if not found. * @return array|null Product data or null if not found.
*/ */
private function find_product_by_identifier( $sku, $gtin ) { private function find_product_by_identifier( $sku, $gtin ) {
try { try {
// List products from merchant center. $page_token = null;
$parameters = array();
// Add pagination support. do {
$max_results = 250; $endpoint = "/products/v1beta/accounts/{$this->merchant_id}/products";
$parameters['maxResults'] = $max_results; $endpoint .= '?pageSize=250';
$products = $this->service->products->listProducts( $this->merchant_id, $parameters ); if ( $page_token ) {
$endpoint .= '&pageToken=' . urlencode( $page_token );
foreach ( $products->getResources() as $product ) {
// Check if SKU or GTIN matches.
$product_data = $product->toSimpleObject();
if ( isset( $product_data->offerId ) && $product_data->offerId === $sku ) {
return $product->getId();
} }
if ( ! empty( $gtin ) && isset( $product_data->gtin ) && $product_data->gtin === $gtin ) { $response = $this->api_request( 'GET', $endpoint );
return $product->getId();
if ( ! empty( $response['products'] ) ) {
foreach ( $response['products'] as $product ) {
// Check if offerId (SKU) matches.
if ( isset( $product['offerId'] ) && $product['offerId'] === $sku ) {
return $product;
}
// Check if GTIN matches.
if ( ! empty( $gtin ) && isset( $product['gtin'] ) && $product['gtin'] === $gtin ) {
return $product;
}
}
} }
}
$page_token = $response['nextPageToken'] ?? null;
} while ( $page_token );
return null; return null;
@@ -154,74 +333,42 @@ class Informatiq_SP_Google_API {
} }
/** /**
* Fetch competitive price for a product. * Fetch competitive pricing data from Reports API.
* *
* @param string $product_id Product ID. * @param string $sku Product SKU.
* @return float|null Lowest competitor price or null if not available. * @param string $gtin Product GTIN.
*/
private function fetch_competitive_price( $product_id ) {
try {
// Get product status which includes competitive pricing data.
$product_status = $this->service->productstatuses->get( $this->merchant_id, $product_id );
// Extract competitive pricing data.
$price_insights = $product_status->getItemLevelIssues();
// Try to get the product to access price competitiveness.
$product = $this->service->products->get( $this->merchant_id, $product_id );
// Check if we have access to competitive visibility data via Reports API.
// Note: This requires the Merchant Center account to have competitor data enabled.
$lowest_price = $this->get_lowest_price_from_competitivevisibility( $product_id );
if ( $lowest_price ) {
return $lowest_price;
}
// Fallback: If competitive visibility is not available, we'll need to use
// the product's own price as reference (this happens when no competitor data exists).
$product_data = $product->toSimpleObject();
if ( isset( $product_data->price->value ) ) {
$this->logger->warning( "No competitive data available for product {$product_id}, using own price as reference" );
return (float) $product_data->price->value;
}
return null;
} catch ( Exception $e ) {
$this->logger->error( 'Error fetching competitive price: ' . $e->getMessage() );
return null;
}
}
/**
* Get lowest price from competitive visibility data.
*
* @param string $product_id Product ID.
* @return float|null Lowest competitor price or null. * @return float|null Lowest competitor price or null.
*/ */
private function get_lowest_price_from_competitivevisibility( $product_id ) { private function fetch_competitive_price_from_reports( $sku, $gtin ) {
try { try {
// Use the Reports API to get competitive pricing data. // Use the Reports API to search for competitive visibility data.
// This requires the account to have access to competitive pricing insights. $endpoint = "/reports/v1beta/accounts/{$this->merchant_id}/reports:search";
$service = new Google_Service_ShoppingContent_Reports( $this->client );
// Note: The actual implementation depends on the specific API endpoints available. // Query for price competitiveness report.
// For this implementation, we'll use a simplified approach. $query = array(
'query' => "SELECT
offer_id,
price_benchmark.price_benchmark_value,
price_benchmark.price_benchmark_currency_code
FROM PriceCompetitivenessProductView
WHERE offer_id = '{$sku}'",
);
// The competitive visibility API may not be directly accessible via standard API. $response = $this->api_request( 'POST', $endpoint, $query );
// In production, you might need to:
// 1. Enable Merchant Center competitive visibility if ( ! empty( $response['results'] ) ) {
// 2. Use the Shopping Ads API foreach ( $response['results'] as $result ) {
// 3. Or scrape data from Google Merchant Center dashboard (not recommended) if ( isset( $result['priceBenchmark']['priceBenchmarkValue']['amountMicros'] ) ) {
return (float) $result['priceBenchmark']['priceBenchmarkValue']['amountMicros'] / 1000000;
}
}
}
// For now, return null to indicate no competitive data found.
// The calling code will handle this gracefully.
return null; return null;
} catch ( Exception $e ) { } catch ( Exception $e ) {
$this->logger->error( 'Error accessing competitive visibility data: ' . $e->getMessage() ); // Reports API might not be available for all accounts.
$this->logger->info( 'Competitive pricing data not available: ' . $e->getMessage() );
return null; return null;
} }
} }
@@ -234,14 +381,14 @@ class Informatiq_SP_Google_API {
public function test_connection() { public function test_connection() {
try { try {
// Try to list products to test connection. // Try to list products to test connection.
$parameters = array( 'maxResults' => 1 ); $endpoint = "/products/v1beta/accounts/{$this->merchant_id}/products?pageSize=1";
$this->service->products->listProducts( $this->merchant_id, $parameters ); $this->api_request( 'GET', $endpoint );
$this->logger->info( 'Google API connection test successful' ); $this->logger->info( 'Google Merchant API connection test successful' );
return true; return true;
} catch ( Exception $e ) { } catch ( Exception $e ) {
$this->logger->error( 'Google API connection test failed: ' . $e->getMessage() ); $this->logger->error( 'Google Merchant API connection test failed: ' . $e->getMessage() );
return false; return false;
} }
} }
@@ -257,22 +404,18 @@ class Informatiq_SP_Google_API {
$page_token = null; $page_token = null;
do { do {
$parameters = array( $endpoint = "/products/v1beta/accounts/{$this->merchant_id}/products";
'maxResults' => 250, $endpoint .= '?pageSize=250';
);
if ( $page_token ) { if ( $page_token ) {
$parameters['pageToken'] = $page_token; $endpoint .= '&pageToken=' . urlencode( $page_token );
} }
$response = $this->service->products->listProducts( $this->merchant_id, $parameters ); $response = $this->api_request( 'GET', $endpoint );
$products = $response->getResources(); $products = $response['products'] ?? array();
$all_products = array_merge( $all_products, $products );
if ( $products ) { $page_token = $response['nextPageToken'] ?? null;
$all_products = array_merge( $all_products, $products );
}
$page_token = $response->getNextPageToken();
} while ( $page_token ); } while ( $page_token );

View File

@@ -40,8 +40,19 @@ class Informatiq_SP_Logger {
*/ */
public function __construct() { public function __construct() {
global $wpdb; global $wpdb;
$this->wc_logger = wc_get_logger(); $this->table_name = $wpdb->prefix . 'informatiq_sp_logs';
$this->table_name = $wpdb->prefix . 'informatiq_sp_logs'; }
/**
* Get WC Logger instance (lazy initialization).
*
* @return WC_Logger|null
*/
private function get_wc_logger() {
if ( null === $this->wc_logger && function_exists( 'wc_get_logger' ) ) {
$this->wc_logger = wc_get_logger();
}
return $this->wc_logger;
} }
/** /**
@@ -77,7 +88,10 @@ class Informatiq_SP_Logger {
* @param array $context Additional context. * @param array $context Additional context.
*/ */
public function info( $message, $context = array() ) { public function info( $message, $context = array() ) {
$this->wc_logger->info( $message, array_merge( array( 'source' => $this->source ), $context ) ); $logger = $this->get_wc_logger();
if ( $logger ) {
$logger->info( $message, array_merge( array( 'source' => $this->source ), $context ) );
}
} }
/** /**
@@ -87,7 +101,10 @@ class Informatiq_SP_Logger {
* @param array $context Additional context. * @param array $context Additional context.
*/ */
public function error( $message, $context = array() ) { public function error( $message, $context = array() ) {
$this->wc_logger->error( $message, array_merge( array( 'source' => $this->source ), $context ) ); $logger = $this->get_wc_logger();
if ( $logger ) {
$logger->error( $message, array_merge( array( 'source' => $this->source ), $context ) );
}
} }
/** /**
@@ -97,7 +114,10 @@ class Informatiq_SP_Logger {
* @param array $context Additional context. * @param array $context Additional context.
*/ */
public function warning( $message, $context = array() ) { public function warning( $message, $context = array() ) {
$this->wc_logger->warning( $message, array_merge( array( 'source' => $this->source ), $context ) ); $logger = $this->get_wc_logger();
if ( $logger ) {
$logger->warning( $message, array_merge( array( 'source' => $this->source ), $context ) );
}
} }
/** /**

View File

@@ -3,7 +3,7 @@
* Plugin Name: informatiq-smart-google-pricing * Plugin Name: informatiq-smart-google-pricing
* Plugin URI: https://informatiq.services * Plugin URI: https://informatiq.services
* Description: Automatically adjusts WooCommerce sale prices based on Google Merchant Center competitor data. * Description: Automatically adjusts WooCommerce sale prices based on Google Merchant Center competitor data.
* Version: 1.0.0 * Version: 2.0.0
* Author: Mălin Cenușă * Author: Mălin Cenușă
* Author URI: https://malin.ro * Author URI: https://malin.ro
* Text Domain: informatiq-smart-pricing * Text Domain: informatiq-smart-pricing
@@ -22,7 +22,7 @@ if ( ! defined( 'ABSPATH' ) ) {
} }
// Define plugin constants. // Define plugin constants.
define( 'INFORMATIQ_SP_VERSION', '1.0.0' ); define( 'INFORMATIQ_SP_VERSION', '2.0.0' );
define( 'INFORMATIQ_SP_PLUGIN_FILE', __FILE__ ); define( 'INFORMATIQ_SP_PLUGIN_FILE', __FILE__ );
define( 'INFORMATIQ_SP_PLUGIN_DIR', plugin_dir_path( __FILE__ ) ); define( 'INFORMATIQ_SP_PLUGIN_DIR', plugin_dir_path( __FILE__ ) );
define( 'INFORMATIQ_SP_PLUGIN_URL', plugin_dir_url( __FILE__ ) ); define( 'INFORMATIQ_SP_PLUGIN_URL', plugin_dir_url( __FILE__ ) );
@@ -82,8 +82,11 @@ class Informatiq_Smart_Google_Pricing {
return; return;
} }
// Load autoloader. // Check for OpenSSL extension (required for JWT signing).
require_once INFORMATIQ_SP_PLUGIN_DIR . 'vendor/autoload.php'; if ( ! extension_loaded( 'openssl' ) ) {
add_action( 'admin_notices', array( $this, 'openssl_missing_notice' ) );
return;
}
// Load plugin classes. // Load plugin classes.
$this->includes(); $this->includes();
@@ -116,6 +119,17 @@ class Informatiq_Smart_Google_Pricing {
<?php <?php
} }
/**
* OpenSSL missing notice.
*/
public function openssl_missing_notice() {
?>
<div class="notice notice-error">
<p><?php esc_html_e( 'Informatiq Smart Google Pricing requires the PHP OpenSSL extension for Google API authentication.', 'informatiq-smart-pricing' ); ?></p>
</div>
<?php
}
/** /**
* Include required files. * Include required files.
*/ */
@@ -190,5 +204,11 @@ function informatiq_sp() {
return Informatiq_Smart_Google_Pricing::instance(); return Informatiq_Smart_Google_Pricing::instance();
} }
// Initialize plugin. /**
informatiq_sp(); * Initialize plugin after all plugins are loaded.
* This ensures WooCommerce functions are available.
*/
function informatiq_sp_init() {
informatiq_sp();
}
add_action( 'plugins_loaded', 'informatiq_sp_init', 20 );

22
vendor/autoload.php vendored
View File

@@ -1,22 +0,0 @@
<?php
// autoload.php @generated by Composer
if (PHP_VERSION_ID < 50600) {
if (!headers_sent()) {
header('HTTP/1.1 500 Internal Server Error');
}
$err = 'Composer 2.3.0 dropped support for autoloading on PHP <5.6 and you are running '.PHP_VERSION.', please upgrade PHP or use Composer 2.2 LTS via "composer self-update --2.2". Aborting.'.PHP_EOL;
if (!ini_get('display_errors')) {
if (PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg') {
fwrite(STDERR, $err);
} elseif (!headers_sent()) {
echo $err;
}
}
throw new RuntimeException($err);
}
require_once __DIR__ . '/composer/autoload_real.php';
return ComposerAutoloaderInitd790aed80352ff5bf2334128a2f033d3::getLoader();

View File

@@ -1,579 +0,0 @@
<?php
/*
* This file is part of Composer.
*
* (c) Nils Adermann <naderman@naderman.de>
* Jordi Boggiano <j.boggiano@seld.be>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Composer\Autoload;
/**
* ClassLoader implements a PSR-0, PSR-4 and classmap class loader.
*
* $loader = new \Composer\Autoload\ClassLoader();
*
* // register classes with namespaces
* $loader->add('Symfony\Component', __DIR__.'/component');
* $loader->add('Symfony', __DIR__.'/framework');
*
* // activate the autoloader
* $loader->register();
*
* // to enable searching the include path (eg. for PEAR packages)
* $loader->setUseIncludePath(true);
*
* In this example, if you try to use a class in the Symfony\Component
* namespace or one of its children (Symfony\Component\Console for instance),
* the autoloader will first look for the class under the component/
* directory, and it will then fallback to the framework/ directory if not
* found before giving up.
*
* This class is loosely based on the Symfony UniversalClassLoader.
*
* @author Fabien Potencier <fabien@symfony.com>
* @author Jordi Boggiano <j.boggiano@seld.be>
* @see https://www.php-fig.org/psr/psr-0/
* @see https://www.php-fig.org/psr/psr-4/
*/
class ClassLoader
{
/** @var \Closure(string):void */
private static $includeFile;
/** @var string|null */
private $vendorDir;
// PSR-4
/**
* @var array<string, array<string, int>>
*/
private $prefixLengthsPsr4 = array();
/**
* @var array<string, list<string>>
*/
private $prefixDirsPsr4 = array();
/**
* @var list<string>
*/
private $fallbackDirsPsr4 = array();
// PSR-0
/**
* List of PSR-0 prefixes
*
* Structured as array('F (first letter)' => array('Foo\Bar (full prefix)' => array('path', 'path2')))
*
* @var array<string, array<string, list<string>>>
*/
private $prefixesPsr0 = array();
/**
* @var list<string>
*/
private $fallbackDirsPsr0 = array();
/** @var bool */
private $useIncludePath = false;
/**
* @var array<string, string>
*/
private $classMap = array();
/** @var bool */
private $classMapAuthoritative = false;
/**
* @var array<string, bool>
*/
private $missingClasses = array();
/** @var string|null */
private $apcuPrefix;
/**
* @var array<string, self>
*/
private static $registeredLoaders = array();
/**
* @param string|null $vendorDir
*/
public function __construct($vendorDir = null)
{
$this->vendorDir = $vendorDir;
self::initializeIncludeClosure();
}
/**
* @return array<string, list<string>>
*/
public function getPrefixes()
{
if (!empty($this->prefixesPsr0)) {
return call_user_func_array('array_merge', array_values($this->prefixesPsr0));
}
return array();
}
/**
* @return array<string, list<string>>
*/
public function getPrefixesPsr4()
{
return $this->prefixDirsPsr4;
}
/**
* @return list<string>
*/
public function getFallbackDirs()
{
return $this->fallbackDirsPsr0;
}
/**
* @return list<string>
*/
public function getFallbackDirsPsr4()
{
return $this->fallbackDirsPsr4;
}
/**
* @return array<string, string> Array of classname => path
*/
public function getClassMap()
{
return $this->classMap;
}
/**
* @param array<string, string> $classMap Class to filename map
*
* @return void
*/
public function addClassMap(array $classMap)
{
if ($this->classMap) {
$this->classMap = array_merge($this->classMap, $classMap);
} else {
$this->classMap = $classMap;
}
}
/**
* Registers a set of PSR-0 directories for a given prefix, either
* appending or prepending to the ones previously set for this prefix.
*
* @param string $prefix The prefix
* @param list<string>|string $paths The PSR-0 root directories
* @param bool $prepend Whether to prepend the directories
*
* @return void
*/
public function add($prefix, $paths, $prepend = false)
{
$paths = (array) $paths;
if (!$prefix) {
if ($prepend) {
$this->fallbackDirsPsr0 = array_merge(
$paths,
$this->fallbackDirsPsr0
);
} else {
$this->fallbackDirsPsr0 = array_merge(
$this->fallbackDirsPsr0,
$paths
);
}
return;
}
$first = $prefix[0];
if (!isset($this->prefixesPsr0[$first][$prefix])) {
$this->prefixesPsr0[$first][$prefix] = $paths;
return;
}
if ($prepend) {
$this->prefixesPsr0[$first][$prefix] = array_merge(
$paths,
$this->prefixesPsr0[$first][$prefix]
);
} else {
$this->prefixesPsr0[$first][$prefix] = array_merge(
$this->prefixesPsr0[$first][$prefix],
$paths
);
}
}
/**
* Registers a set of PSR-4 directories for a given namespace, either
* appending or prepending to the ones previously set for this namespace.
*
* @param string $prefix The prefix/namespace, with trailing '\\'
* @param list<string>|string $paths The PSR-4 base directories
* @param bool $prepend Whether to prepend the directories
*
* @throws \InvalidArgumentException
*
* @return void
*/
public function addPsr4($prefix, $paths, $prepend = false)
{
$paths = (array) $paths;
if (!$prefix) {
// Register directories for the root namespace.
if ($prepend) {
$this->fallbackDirsPsr4 = array_merge(
$paths,
$this->fallbackDirsPsr4
);
} else {
$this->fallbackDirsPsr4 = array_merge(
$this->fallbackDirsPsr4,
$paths
);
}
} elseif (!isset($this->prefixDirsPsr4[$prefix])) {
// Register directories for a new namespace.
$length = strlen($prefix);
if ('\\' !== $prefix[$length - 1]) {
throw new \InvalidArgumentException("A non-empty PSR-4 prefix must end with a namespace separator.");
}
$this->prefixLengthsPsr4[$prefix[0]][$prefix] = $length;
$this->prefixDirsPsr4[$prefix] = $paths;
} elseif ($prepend) {
// Prepend directories for an already registered namespace.
$this->prefixDirsPsr4[$prefix] = array_merge(
$paths,
$this->prefixDirsPsr4[$prefix]
);
} else {
// Append directories for an already registered namespace.
$this->prefixDirsPsr4[$prefix] = array_merge(
$this->prefixDirsPsr4[$prefix],
$paths
);
}
}
/**
* Registers a set of PSR-0 directories for a given prefix,
* replacing any others previously set for this prefix.
*
* @param string $prefix The prefix
* @param list<string>|string $paths The PSR-0 base directories
*
* @return void
*/
public function set($prefix, $paths)
{
if (!$prefix) {
$this->fallbackDirsPsr0 = (array) $paths;
} else {
$this->prefixesPsr0[$prefix[0]][$prefix] = (array) $paths;
}
}
/**
* Registers a set of PSR-4 directories for a given namespace,
* replacing any others previously set for this namespace.
*
* @param string $prefix The prefix/namespace, with trailing '\\'
* @param list<string>|string $paths The PSR-4 base directories
*
* @throws \InvalidArgumentException
*
* @return void
*/
public function setPsr4($prefix, $paths)
{
if (!$prefix) {
$this->fallbackDirsPsr4 = (array) $paths;
} else {
$length = strlen($prefix);
if ('\\' !== $prefix[$length - 1]) {
throw new \InvalidArgumentException("A non-empty PSR-4 prefix must end with a namespace separator.");
}
$this->prefixLengthsPsr4[$prefix[0]][$prefix] = $length;
$this->prefixDirsPsr4[$prefix] = (array) $paths;
}
}
/**
* Turns on searching the include path for class files.
*
* @param bool $useIncludePath
*
* @return void
*/
public function setUseIncludePath($useIncludePath)
{
$this->useIncludePath = $useIncludePath;
}
/**
* Can be used to check if the autoloader uses the include path to check
* for classes.
*
* @return bool
*/
public function getUseIncludePath()
{
return $this->useIncludePath;
}
/**
* Turns off searching the prefix and fallback directories for classes
* that have not been registered with the class map.
*
* @param bool $classMapAuthoritative
*
* @return void
*/
public function setClassMapAuthoritative($classMapAuthoritative)
{
$this->classMapAuthoritative = $classMapAuthoritative;
}
/**
* Should class lookup fail if not found in the current class map?
*
* @return bool
*/
public function isClassMapAuthoritative()
{
return $this->classMapAuthoritative;
}
/**
* APCu prefix to use to cache found/not-found classes, if the extension is enabled.
*
* @param string|null $apcuPrefix
*
* @return void
*/
public function setApcuPrefix($apcuPrefix)
{
$this->apcuPrefix = function_exists('apcu_fetch') && filter_var(ini_get('apc.enabled'), FILTER_VALIDATE_BOOLEAN) ? $apcuPrefix : null;
}
/**
* The APCu prefix in use, or null if APCu caching is not enabled.
*
* @return string|null
*/
public function getApcuPrefix()
{
return $this->apcuPrefix;
}
/**
* Registers this instance as an autoloader.
*
* @param bool $prepend Whether to prepend the autoloader or not
*
* @return void
*/
public function register($prepend = false)
{
spl_autoload_register(array($this, 'loadClass'), true, $prepend);
if (null === $this->vendorDir) {
return;
}
if ($prepend) {
self::$registeredLoaders = array($this->vendorDir => $this) + self::$registeredLoaders;
} else {
unset(self::$registeredLoaders[$this->vendorDir]);
self::$registeredLoaders[$this->vendorDir] = $this;
}
}
/**
* Unregisters this instance as an autoloader.
*
* @return void
*/
public function unregister()
{
spl_autoload_unregister(array($this, 'loadClass'));
if (null !== $this->vendorDir) {
unset(self::$registeredLoaders[$this->vendorDir]);
}
}
/**
* Loads the given class or interface.
*
* @param string $class The name of the class
* @return true|null True if loaded, null otherwise
*/
public function loadClass($class)
{
if ($file = $this->findFile($class)) {
$includeFile = self::$includeFile;
$includeFile($file);
return true;
}
return null;
}
/**
* Finds the path to the file where the class is defined.
*
* @param string $class The name of the class
*
* @return string|false The path if found, false otherwise
*/
public function findFile($class)
{
// class map lookup
if (isset($this->classMap[$class])) {
return $this->classMap[$class];
}
if ($this->classMapAuthoritative || isset($this->missingClasses[$class])) {
return false;
}
if (null !== $this->apcuPrefix) {
$file = apcu_fetch($this->apcuPrefix.$class, $hit);
if ($hit) {
return $file;
}
}
$file = $this->findFileWithExtension($class, '.php');
// Search for Hack files if we are running on HHVM
if (false === $file && defined('HHVM_VERSION')) {
$file = $this->findFileWithExtension($class, '.hh');
}
if (null !== $this->apcuPrefix) {
apcu_add($this->apcuPrefix.$class, $file);
}
if (false === $file) {
// Remember that this class does not exist.
$this->missingClasses[$class] = true;
}
return $file;
}
/**
* Returns the currently registered loaders keyed by their corresponding vendor directories.
*
* @return array<string, self>
*/
public static function getRegisteredLoaders()
{
return self::$registeredLoaders;
}
/**
* @param string $class
* @param string $ext
* @return string|false
*/
private function findFileWithExtension($class, $ext)
{
// PSR-4 lookup
$logicalPathPsr4 = strtr($class, '\\', DIRECTORY_SEPARATOR) . $ext;
$first = $class[0];
if (isset($this->prefixLengthsPsr4[$first])) {
$subPath = $class;
while (false !== $lastPos = strrpos($subPath, '\\')) {
$subPath = substr($subPath, 0, $lastPos);
$search = $subPath . '\\';
if (isset($this->prefixDirsPsr4[$search])) {
$pathEnd = DIRECTORY_SEPARATOR . substr($logicalPathPsr4, $lastPos + 1);
foreach ($this->prefixDirsPsr4[$search] as $dir) {
if (file_exists($file = $dir . $pathEnd)) {
return $file;
}
}
}
}
}
// PSR-4 fallback dirs
foreach ($this->fallbackDirsPsr4 as $dir) {
if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr4)) {
return $file;
}
}
// PSR-0 lookup
if (false !== $pos = strrpos($class, '\\')) {
// namespaced class name
$logicalPathPsr0 = substr($logicalPathPsr4, 0, $pos + 1)
. strtr(substr($logicalPathPsr4, $pos + 1), '_', DIRECTORY_SEPARATOR);
} else {
// PEAR-like class name
$logicalPathPsr0 = strtr($class, '_', DIRECTORY_SEPARATOR) . $ext;
}
if (isset($this->prefixesPsr0[$first])) {
foreach ($this->prefixesPsr0[$first] as $prefix => $dirs) {
if (0 === strpos($class, $prefix)) {
foreach ($dirs as $dir) {
if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0)) {
return $file;
}
}
}
}
}
// PSR-0 fallback dirs
foreach ($this->fallbackDirsPsr0 as $dir) {
if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0)) {
return $file;
}
}
// PSR-0 include paths.
if ($this->useIncludePath && $file = stream_resolve_include_path($logicalPathPsr0)) {
return $file;
}
return false;
}
/**
* @return void
*/
private static function initializeIncludeClosure()
{
if (self::$includeFile !== null) {
return;
}
/**
* Scope isolated include.
*
* Prevents access to $this/self from included files.
*
* @param string $file
* @return void
*/
self::$includeFile = \Closure::bind(static function($file) {
include $file;
}, null, null);
}
}

View File

@@ -1,396 +0,0 @@
<?php
/*
* This file is part of Composer.
*
* (c) Nils Adermann <naderman@naderman.de>
* Jordi Boggiano <j.boggiano@seld.be>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Composer;
use Composer\Autoload\ClassLoader;
use Composer\Semver\VersionParser;
/**
* This class is copied in every Composer installed project and available to all
*
* See also https://getcomposer.org/doc/07-runtime.md#installed-versions
*
* To require its presence, you can require `composer-runtime-api ^2.0`
*
* @final
*/
class InstalledVersions
{
/**
* @var string|null if set (by reflection by Composer), this should be set to the path where this class is being copied to
* @internal
*/
private static $selfDir = null;
/**
* @var mixed[]|null
* @psalm-var array{root: array{name: string, pretty_version: string, version: string, reference: string|null, type: string, install_path: string, aliases: string[], dev: bool}, versions: array<string, array{pretty_version?: string, version?: string, reference?: string|null, type?: string, install_path?: string, aliases?: string[], dev_requirement: bool, replaced?: string[], provided?: string[]}>}|array{}|null
*/
private static $installed;
/**
* @var bool
*/
private static $installedIsLocalDir;
/**
* @var bool|null
*/
private static $canGetVendors;
/**
* @var array[]
* @psalm-var array<string, array{root: array{name: string, pretty_version: string, version: string, reference: string|null, type: string, install_path: string, aliases: string[], dev: bool}, versions: array<string, array{pretty_version?: string, version?: string, reference?: string|null, type?: string, install_path?: string, aliases?: string[], dev_requirement: bool, replaced?: string[], provided?: string[]}>}>
*/
private static $installedByVendor = array();
/**
* Returns a list of all package names which are present, either by being installed, replaced or provided
*
* @return string[]
* @psalm-return list<string>
*/
public static function getInstalledPackages()
{
$packages = array();
foreach (self::getInstalled() as $installed) {
$packages[] = array_keys($installed['versions']);
}
if (1 === \count($packages)) {
return $packages[0];
}
return array_keys(array_flip(\call_user_func_array('array_merge', $packages)));
}
/**
* Returns a list of all package names with a specific type e.g. 'library'
*
* @param string $type
* @return string[]
* @psalm-return list<string>
*/
public static function getInstalledPackagesByType($type)
{
$packagesByType = array();
foreach (self::getInstalled() as $installed) {
foreach ($installed['versions'] as $name => $package) {
if (isset($package['type']) && $package['type'] === $type) {
$packagesByType[] = $name;
}
}
}
return $packagesByType;
}
/**
* Checks whether the given package is installed
*
* This also returns true if the package name is provided or replaced by another package
*
* @param string $packageName
* @param bool $includeDevRequirements
* @return bool
*/
public static function isInstalled($packageName, $includeDevRequirements = true)
{
foreach (self::getInstalled() as $installed) {
if (isset($installed['versions'][$packageName])) {
return $includeDevRequirements || !isset($installed['versions'][$packageName]['dev_requirement']) || $installed['versions'][$packageName]['dev_requirement'] === false;
}
}
return false;
}
/**
* Checks whether the given package satisfies a version constraint
*
* e.g. If you want to know whether version 2.3+ of package foo/bar is installed, you would call:
*
* Composer\InstalledVersions::satisfies(new VersionParser, 'foo/bar', '^2.3')
*
* @param VersionParser $parser Install composer/semver to have access to this class and functionality
* @param string $packageName
* @param string|null $constraint A version constraint to check for, if you pass one you have to make sure composer/semver is required by your package
* @return bool
*/
public static function satisfies(VersionParser $parser, $packageName, $constraint)
{
$constraint = $parser->parseConstraints((string) $constraint);
$provided = $parser->parseConstraints(self::getVersionRanges($packageName));
return $provided->matches($constraint);
}
/**
* Returns a version constraint representing all the range(s) which are installed for a given package
*
* It is easier to use this via isInstalled() with the $constraint argument if you need to check
* whether a given version of a package is installed, and not just whether it exists
*
* @param string $packageName
* @return string Version constraint usable with composer/semver
*/
public static function getVersionRanges($packageName)
{
foreach (self::getInstalled() as $installed) {
if (!isset($installed['versions'][$packageName])) {
continue;
}
$ranges = array();
if (isset($installed['versions'][$packageName]['pretty_version'])) {
$ranges[] = $installed['versions'][$packageName]['pretty_version'];
}
if (array_key_exists('aliases', $installed['versions'][$packageName])) {
$ranges = array_merge($ranges, $installed['versions'][$packageName]['aliases']);
}
if (array_key_exists('replaced', $installed['versions'][$packageName])) {
$ranges = array_merge($ranges, $installed['versions'][$packageName]['replaced']);
}
if (array_key_exists('provided', $installed['versions'][$packageName])) {
$ranges = array_merge($ranges, $installed['versions'][$packageName]['provided']);
}
return implode(' || ', $ranges);
}
throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed');
}
/**
* @param string $packageName
* @return string|null If the package is being replaced or provided but is not really installed, null will be returned as version, use satisfies or getVersionRanges if you need to know if a given version is present
*/
public static function getVersion($packageName)
{
foreach (self::getInstalled() as $installed) {
if (!isset($installed['versions'][$packageName])) {
continue;
}
if (!isset($installed['versions'][$packageName]['version'])) {
return null;
}
return $installed['versions'][$packageName]['version'];
}
throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed');
}
/**
* @param string $packageName
* @return string|null If the package is being replaced or provided but is not really installed, null will be returned as version, use satisfies or getVersionRanges if you need to know if a given version is present
*/
public static function getPrettyVersion($packageName)
{
foreach (self::getInstalled() as $installed) {
if (!isset($installed['versions'][$packageName])) {
continue;
}
if (!isset($installed['versions'][$packageName]['pretty_version'])) {
return null;
}
return $installed['versions'][$packageName]['pretty_version'];
}
throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed');
}
/**
* @param string $packageName
* @return string|null If the package is being replaced or provided but is not really installed, null will be returned as reference
*/
public static function getReference($packageName)
{
foreach (self::getInstalled() as $installed) {
if (!isset($installed['versions'][$packageName])) {
continue;
}
if (!isset($installed['versions'][$packageName]['reference'])) {
return null;
}
return $installed['versions'][$packageName]['reference'];
}
throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed');
}
/**
* @param string $packageName
* @return string|null If the package is being replaced or provided but is not really installed, null will be returned as install path. Packages of type metapackages also have a null install path.
*/
public static function getInstallPath($packageName)
{
foreach (self::getInstalled() as $installed) {
if (!isset($installed['versions'][$packageName])) {
continue;
}
return isset($installed['versions'][$packageName]['install_path']) ? $installed['versions'][$packageName]['install_path'] : null;
}
throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed');
}
/**
* @return array
* @psalm-return array{name: string, pretty_version: string, version: string, reference: string|null, type: string, install_path: string, aliases: string[], dev: bool}
*/
public static function getRootPackage()
{
$installed = self::getInstalled();
return $installed[0]['root'];
}
/**
* Returns the raw installed.php data for custom implementations
*
* @deprecated Use getAllRawData() instead which returns all datasets for all autoloaders present in the process. getRawData only returns the first dataset loaded, which may not be what you expect.
* @return array[]
* @psalm-return array{root: array{name: string, pretty_version: string, version: string, reference: string|null, type: string, install_path: string, aliases: string[], dev: bool}, versions: array<string, array{pretty_version?: string, version?: string, reference?: string|null, type?: string, install_path?: string, aliases?: string[], dev_requirement: bool, replaced?: string[], provided?: string[]}>}
*/
public static function getRawData()
{
@trigger_error('getRawData only returns the first dataset loaded, which may not be what you expect. Use getAllRawData() instead which returns all datasets for all autoloaders present in the process.', E_USER_DEPRECATED);
if (null === self::$installed) {
// only require the installed.php file if this file is loaded from its dumped location,
// and not from its source location in the composer/composer package, see https://github.com/composer/composer/issues/9937
if (substr(__DIR__, -8, 1) !== 'C') {
self::$installed = include __DIR__ . '/installed.php';
} else {
self::$installed = array();
}
}
return self::$installed;
}
/**
* Returns the raw data of all installed.php which are currently loaded for custom implementations
*
* @return array[]
* @psalm-return list<array{root: array{name: string, pretty_version: string, version: string, reference: string|null, type: string, install_path: string, aliases: string[], dev: bool}, versions: array<string, array{pretty_version?: string, version?: string, reference?: string|null, type?: string, install_path?: string, aliases?: string[], dev_requirement: bool, replaced?: string[], provided?: string[]}>}>
*/
public static function getAllRawData()
{
return self::getInstalled();
}
/**
* Lets you reload the static array from another file
*
* This is only useful for complex integrations in which a project needs to use
* this class but then also needs to execute another project's autoloader in process,
* and wants to ensure both projects have access to their version of installed.php.
*
* A typical case would be PHPUnit, where it would need to make sure it reads all
* the data it needs from this class, then call reload() with
* `require $CWD/vendor/composer/installed.php` (or similar) as input to make sure
* the project in which it runs can then also use this class safely, without
* interference between PHPUnit's dependencies and the project's dependencies.
*
* @param array[] $data A vendor/composer/installed.php data set
* @return void
*
* @psalm-param array{root: array{name: string, pretty_version: string, version: string, reference: string|null, type: string, install_path: string, aliases: string[], dev: bool}, versions: array<string, array{pretty_version?: string, version?: string, reference?: string|null, type?: string, install_path?: string, aliases?: string[], dev_requirement: bool, replaced?: string[], provided?: string[]}>} $data
*/
public static function reload($data)
{
self::$installed = $data;
self::$installedByVendor = array();
// when using reload, we disable the duplicate protection to ensure that self::$installed data is
// always returned, but we cannot know whether it comes from the installed.php in __DIR__ or not,
// so we have to assume it does not, and that may result in duplicate data being returned when listing
// all installed packages for example
self::$installedIsLocalDir = false;
}
/**
* @return string
*/
private static function getSelfDir()
{
if (self::$selfDir === null) {
self::$selfDir = strtr(__DIR__, '\\', '/');
}
return self::$selfDir;
}
/**
* @return array[]
* @psalm-return list<array{root: array{name: string, pretty_version: string, version: string, reference: string|null, type: string, install_path: string, aliases: string[], dev: bool}, versions: array<string, array{pretty_version?: string, version?: string, reference?: string|null, type?: string, install_path?: string, aliases?: string[], dev_requirement: bool, replaced?: string[], provided?: string[]}>}>
*/
private static function getInstalled()
{
if (null === self::$canGetVendors) {
self::$canGetVendors = method_exists('Composer\Autoload\ClassLoader', 'getRegisteredLoaders');
}
$installed = array();
$copiedLocalDir = false;
if (self::$canGetVendors) {
$selfDir = self::getSelfDir();
foreach (ClassLoader::getRegisteredLoaders() as $vendorDir => $loader) {
$vendorDir = strtr($vendorDir, '\\', '/');
if (isset(self::$installedByVendor[$vendorDir])) {
$installed[] = self::$installedByVendor[$vendorDir];
} elseif (is_file($vendorDir.'/composer/installed.php')) {
/** @var array{root: array{name: string, pretty_version: string, version: string, reference: string|null, type: string, install_path: string, aliases: string[], dev: bool}, versions: array<string, array{pretty_version?: string, version?: string, reference?: string|null, type?: string, install_path?: string, aliases?: string[], dev_requirement: bool, replaced?: string[], provided?: string[]}>} $required */
$required = require $vendorDir.'/composer/installed.php';
self::$installedByVendor[$vendorDir] = $required;
$installed[] = $required;
if (self::$installed === null && $vendorDir.'/composer' === $selfDir) {
self::$installed = $required;
self::$installedIsLocalDir = true;
}
}
if (self::$installedIsLocalDir && $vendorDir.'/composer' === $selfDir) {
$copiedLocalDir = true;
}
}
}
if (null === self::$installed) {
// only require the installed.php file if this file is loaded from its dumped location,
// and not from its source location in the composer/composer package, see https://github.com/composer/composer/issues/9937
if (substr(__DIR__, -8, 1) !== 'C') {
/** @var array{root: array{name: string, pretty_version: string, version: string, reference: string|null, type: string, install_path: string, aliases: string[], dev: bool}, versions: array<string, array{pretty_version?: string, version?: string, reference?: string|null, type?: string, install_path?: string, aliases?: string[], dev_requirement: bool, replaced?: string[], provided?: string[]}>} $required */
$required = require __DIR__ . '/installed.php';
self::$installed = $required;
} else {
self::$installed = array();
}
}
if (self::$installed !== array() && !$copiedLocalDir) {
$installed[] = self::$installed;
}
return $installed;
}
}

View File

@@ -1,21 +0,0 @@
Copyright (c) Nils Adermann, Jordi Boggiano
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished
to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

File diff suppressed because it is too large Load Diff

View File

@@ -1,15 +0,0 @@
<?php
// autoload_files.php @generated by Composer
$vendorDir = dirname(__DIR__);
$baseDir = dirname($vendorDir);
return array(
'7b11c4dc42b3b3023073cb14e519683c' => $vendorDir . '/ralouphie/getallheaders/src/getallheaders.php',
'6e3fae29631ef280660b3cdad06f25a8' => $vendorDir . '/symfony/deprecation-contracts/function.php',
'37a3dc5111fe8f707ab4c132ef1dbc62' => $vendorDir . '/guzzlehttp/guzzle/src/functions_include.php',
'1f87db08236948d07391152dccb70f04' => $vendorDir . '/google/apiclient-services/autoload.php',
'decc78cc4436b1292c6c0d151b19445c' => $vendorDir . '/phpseclib/phpseclib/phpseclib/bootstrap.php',
'a8d3953fd9959404dd22d3dfcd0a79f0' => $vendorDir . '/google/apiclient/src/aliases.php',
);

View File

@@ -1,9 +0,0 @@
<?php
// autoload_namespaces.php @generated by Composer
$vendorDir = dirname(__DIR__);
$baseDir = dirname($vendorDir);
return array(
);

View File

@@ -1,24 +0,0 @@
<?php
// autoload_psr4.php @generated by Composer
$vendorDir = dirname(__DIR__);
$baseDir = dirname($vendorDir);
return array(
'phpseclib3\\' => array($vendorDir . '/phpseclib/phpseclib/phpseclib'),
'Psr\\Log\\' => array($vendorDir . '/psr/log/src'),
'Psr\\Http\\Message\\' => array($vendorDir . '/psr/http-factory/src', $vendorDir . '/psr/http-message/src'),
'Psr\\Http\\Client\\' => array($vendorDir . '/psr/http-client/src'),
'Psr\\Cache\\' => array($vendorDir . '/psr/cache/src'),
'ParagonIE\\ConstantTime\\' => array($vendorDir . '/paragonie/constant_time_encoding/src'),
'Monolog\\' => array($vendorDir . '/monolog/monolog/src/Monolog'),
'Informatiq\\SmartPricing\\' => array($baseDir . '/includes'),
'GuzzleHttp\\Psr7\\' => array($vendorDir . '/guzzlehttp/psr7/src'),
'GuzzleHttp\\Promise\\' => array($vendorDir . '/guzzlehttp/promises/src'),
'GuzzleHttp\\' => array($vendorDir . '/guzzlehttp/guzzle/src'),
'Google\\Service\\' => array($vendorDir . '/google/apiclient-services/src'),
'Google\\Auth\\' => array($vendorDir . '/google/auth/src'),
'Google\\' => array($vendorDir . '/google/apiclient/src'),
'Firebase\\JWT\\' => array($vendorDir . '/firebase/php-jwt/src'),
);

View File

@@ -1,50 +0,0 @@
<?php
// autoload_real.php @generated by Composer
class ComposerAutoloaderInitd790aed80352ff5bf2334128a2f033d3
{
private static $loader;
public static function loadClassLoader($class)
{
if ('Composer\Autoload\ClassLoader' === $class) {
require __DIR__ . '/ClassLoader.php';
}
}
/**
* @return \Composer\Autoload\ClassLoader
*/
public static function getLoader()
{
if (null !== self::$loader) {
return self::$loader;
}
require __DIR__ . '/platform_check.php';
spl_autoload_register(array('ComposerAutoloaderInitd790aed80352ff5bf2334128a2f033d3', 'loadClassLoader'), true, true);
self::$loader = $loader = new \Composer\Autoload\ClassLoader(\dirname(__DIR__));
spl_autoload_unregister(array('ComposerAutoloaderInitd790aed80352ff5bf2334128a2f033d3', 'loadClassLoader'));
require __DIR__ . '/autoload_static.php';
call_user_func(\Composer\Autoload\ComposerStaticInitd790aed80352ff5bf2334128a2f033d3::getInitializer($loader));
$loader->register(true);
$filesToLoad = \Composer\Autoload\ComposerStaticInitd790aed80352ff5bf2334128a2f033d3::$files;
$requireFile = \Closure::bind(static function ($fileIdentifier, $file) {
if (empty($GLOBALS['__composer_autoload_files'][$fileIdentifier])) {
$GLOBALS['__composer_autoload_files'][$fileIdentifier] = true;
require $file;
}
}, null, null);
foreach ($filesToLoad as $fileIdentifier => $file) {
$requireFile($fileIdentifier, $file);
}
return $loader;
}
}

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -1,209 +0,0 @@
<?php return array(
'root' => array(
'name' => 'informatiq/smart-google-pricing',
'pretty_version' => '1.0.0+no-version-set',
'version' => '1.0.0.0',
'reference' => null,
'type' => 'wordpress-plugin',
'install_path' => __DIR__ . '/../../',
'aliases' => array(),
'dev' => false,
),
'versions' => array(
'firebase/php-jwt' => array(
'pretty_version' => 'v6.11.1',
'version' => '6.11.1.0',
'reference' => 'd1e91ecf8c598d073d0995afa8cd5c75c6e19e66',
'type' => 'library',
'install_path' => __DIR__ . '/../firebase/php-jwt',
'aliases' => array(),
'dev_requirement' => false,
),
'google/apiclient' => array(
'pretty_version' => 'v2.18.4',
'version' => '2.18.4.0',
'reference' => '5b51fdb2cbd2a96088e3dfc6f565bdf6fb0af94b',
'type' => 'library',
'install_path' => __DIR__ . '/../google/apiclient',
'aliases' => array(),
'dev_requirement' => false,
),
'google/apiclient-services' => array(
'pretty_version' => 'v0.425.0',
'version' => '0.425.0.0',
'reference' => '3dc7a1bf23d0fee0f701d9a249c8f2ed622c16ec',
'type' => 'library',
'install_path' => __DIR__ . '/../google/apiclient-services',
'aliases' => array(),
'dev_requirement' => false,
),
'google/auth' => array(
'pretty_version' => 'v1.49.0',
'version' => '1.49.0.0',
'reference' => '68e3d88cb59a49f713e3db25d4f6bb3cc0b70764',
'type' => 'library',
'install_path' => __DIR__ . '/../google/auth',
'aliases' => array(),
'dev_requirement' => false,
),
'guzzlehttp/guzzle' => array(
'pretty_version' => '7.10.0',
'version' => '7.10.0.0',
'reference' => 'b51ac707cfa420b7bfd4e4d5e510ba8008e822b4',
'type' => 'library',
'install_path' => __DIR__ . '/../guzzlehttp/guzzle',
'aliases' => array(),
'dev_requirement' => false,
),
'guzzlehttp/promises' => array(
'pretty_version' => '2.3.0',
'version' => '2.3.0.0',
'reference' => '481557b130ef3790cf82b713667b43030dc9c957',
'type' => 'library',
'install_path' => __DIR__ . '/../guzzlehttp/promises',
'aliases' => array(),
'dev_requirement' => false,
),
'guzzlehttp/psr7' => array(
'pretty_version' => '2.8.0',
'version' => '2.8.0.0',
'reference' => '21dc724a0583619cd1652f673303492272778051',
'type' => 'library',
'install_path' => __DIR__ . '/../guzzlehttp/psr7',
'aliases' => array(),
'dev_requirement' => false,
),
'informatiq/smart-google-pricing' => array(
'pretty_version' => '1.0.0+no-version-set',
'version' => '1.0.0.0',
'reference' => null,
'type' => 'wordpress-plugin',
'install_path' => __DIR__ . '/../../',
'aliases' => array(),
'dev_requirement' => false,
),
'monolog/monolog' => array(
'pretty_version' => '3.9.0',
'version' => '3.9.0.0',
'reference' => '10d85740180ecba7896c87e06a166e0c95a0e3b6',
'type' => 'library',
'install_path' => __DIR__ . '/../monolog/monolog',
'aliases' => array(),
'dev_requirement' => false,
),
'paragonie/constant_time_encoding' => array(
'pretty_version' => 'v3.1.3',
'version' => '3.1.3.0',
'reference' => 'd5b01a39b3415c2cd581d3bd3a3575c1ebbd8e77',
'type' => 'library',
'install_path' => __DIR__ . '/../paragonie/constant_time_encoding',
'aliases' => array(),
'dev_requirement' => false,
),
'paragonie/random_compat' => array(
'pretty_version' => 'v9.99.100',
'version' => '9.99.100.0',
'reference' => '996434e5492cb4c3edcb9168db6fbb1359ef965a',
'type' => 'library',
'install_path' => __DIR__ . '/../paragonie/random_compat',
'aliases' => array(),
'dev_requirement' => false,
),
'phpseclib/phpseclib' => array(
'pretty_version' => '3.0.48',
'version' => '3.0.48.0',
'reference' => '64065a5679c50acb886e82c07aa139b0f757bb89',
'type' => 'library',
'install_path' => __DIR__ . '/../phpseclib/phpseclib',
'aliases' => array(),
'dev_requirement' => false,
),
'psr/cache' => array(
'pretty_version' => '3.0.0',
'version' => '3.0.0.0',
'reference' => 'aa5030cfa5405eccfdcb1083ce040c2cb8d253bf',
'type' => 'library',
'install_path' => __DIR__ . '/../psr/cache',
'aliases' => array(),
'dev_requirement' => false,
),
'psr/http-client' => array(
'pretty_version' => '1.0.3',
'version' => '1.0.3.0',
'reference' => 'bb5906edc1c324c9a05aa0873d40117941e5fa90',
'type' => 'library',
'install_path' => __DIR__ . '/../psr/http-client',
'aliases' => array(),
'dev_requirement' => false,
),
'psr/http-client-implementation' => array(
'dev_requirement' => false,
'provided' => array(
0 => '1.0',
),
),
'psr/http-factory' => array(
'pretty_version' => '1.1.0',
'version' => '1.1.0.0',
'reference' => '2b4765fddfe3b508ac62f829e852b1501d3f6e8a',
'type' => 'library',
'install_path' => __DIR__ . '/../psr/http-factory',
'aliases' => array(),
'dev_requirement' => false,
),
'psr/http-factory-implementation' => array(
'dev_requirement' => false,
'provided' => array(
0 => '1.0',
),
),
'psr/http-message' => array(
'pretty_version' => '2.0',
'version' => '2.0.0.0',
'reference' => '402d35bcb92c70c026d1a6a9883f06b2ead23d71',
'type' => 'library',
'install_path' => __DIR__ . '/../psr/http-message',
'aliases' => array(),
'dev_requirement' => false,
),
'psr/http-message-implementation' => array(
'dev_requirement' => false,
'provided' => array(
0 => '1.0',
),
),
'psr/log' => array(
'pretty_version' => '3.0.2',
'version' => '3.0.2.0',
'reference' => 'f16e1d5863e37f8d8c2a01719f5b34baa2b714d3',
'type' => 'library',
'install_path' => __DIR__ . '/../psr/log',
'aliases' => array(),
'dev_requirement' => false,
),
'psr/log-implementation' => array(
'dev_requirement' => false,
'provided' => array(
0 => '3.0.0',
),
),
'ralouphie/getallheaders' => array(
'pretty_version' => '3.0.3',
'version' => '3.0.3.0',
'reference' => '120b605dfeb996808c31b6477290a714d356e822',
'type' => 'library',
'install_path' => __DIR__ . '/../ralouphie/getallheaders',
'aliases' => array(),
'dev_requirement' => false,
),
'symfony/deprecation-contracts' => array(
'pretty_version' => 'v3.6.0',
'version' => '3.6.0.0',
'reference' => '63afe740e99a13ba87ec199bb07bbdee937a5b62',
'type' => 'library',
'install_path' => __DIR__ . '/../symfony/deprecation-contracts',
'aliases' => array(),
'dev_requirement' => false,
),
),
);

View File

@@ -1,25 +0,0 @@
<?php
// platform_check.php @generated by Composer
$issues = array();
if (!(PHP_VERSION_ID >= 80100)) {
$issues[] = 'Your Composer dependencies require a PHP version ">= 8.1.0". You are running ' . PHP_VERSION . '.';
}
if ($issues) {
if (!headers_sent()) {
header('HTTP/1.1 500 Internal Server Error');
}
if (!ini_get('display_errors')) {
if (PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg') {
fwrite(STDERR, 'Composer detected issues in your platform:' . PHP_EOL.PHP_EOL . implode(PHP_EOL, $issues) . PHP_EOL.PHP_EOL);
} elseif (!headers_sent()) {
echo 'Composer detected issues in your platform:' . PHP_EOL.PHP_EOL . str_replace('You are running '.PHP_VERSION.'.', '', implode(PHP_EOL, $issues)) . PHP_EOL.PHP_EOL;
}
}
throw new \RuntimeException(
'Composer detected issues in your platform: ' . implode(' ', $issues)
);
}

View File

@@ -1,205 +0,0 @@
# Changelog
## [6.11.1](https://github.com/firebase/php-jwt/compare/v6.11.0...v6.11.1) (2025-04-09)
### Bug Fixes
* update error text for consistency ([#528](https://github.com/firebase/php-jwt/issues/528)) ([c11113a](https://github.com/firebase/php-jwt/commit/c11113afa13265e016a669e75494b9203b8a7775))
## [6.11.0](https://github.com/firebase/php-jwt/compare/v6.10.2...v6.11.0) (2025-01-23)
### Features
* support octet typed JWK ([#587](https://github.com/firebase/php-jwt/issues/587)) ([7cb8a26](https://github.com/firebase/php-jwt/commit/7cb8a265fa81edf2fa6ef8098f5bc5ae573c33ad))
### Bug Fixes
* refactor constructor Key to use PHP 8.0 syntax ([#577](https://github.com/firebase/php-jwt/issues/577)) ([29fa2ce](https://github.com/firebase/php-jwt/commit/29fa2ce9e0582cd397711eec1e80c05ce20fabca))
## [6.10.2](https://github.com/firebase/php-jwt/compare/v6.10.1...v6.10.2) (2024-11-24)
### Bug Fixes
* Mitigate PHP8.4 deprecation warnings ([#570](https://github.com/firebase/php-jwt/issues/570)) ([76808fa](https://github.com/firebase/php-jwt/commit/76808fa227f3811aa5cdb3bf81233714b799a5b5))
* support php 8.4 ([#583](https://github.com/firebase/php-jwt/issues/583)) ([e3d68b0](https://github.com/firebase/php-jwt/commit/e3d68b044421339443c74199edd020e03fb1887e))
## [6.10.1](https://github.com/firebase/php-jwt/compare/v6.10.0...v6.10.1) (2024-05-18)
### Bug Fixes
* ensure ratelimit expiry is set every time ([#556](https://github.com/firebase/php-jwt/issues/556)) ([09cb208](https://github.com/firebase/php-jwt/commit/09cb2081c2c3bc0f61e2f2a5fbea5741f7498648))
* ratelimit cache expiration ([#550](https://github.com/firebase/php-jwt/issues/550)) ([dda7250](https://github.com/firebase/php-jwt/commit/dda725033585ece30ff8cae8937320d7e9f18bae))
## [6.10.0](https://github.com/firebase/php-jwt/compare/v6.9.0...v6.10.0) (2023-11-28)
### Features
* allow typ header override ([#546](https://github.com/firebase/php-jwt/issues/546)) ([79cb30b](https://github.com/firebase/php-jwt/commit/79cb30b729a22931b2fbd6b53f20629a83031ba9))
## [6.9.0](https://github.com/firebase/php-jwt/compare/v6.8.1...v6.9.0) (2023-10-04)
### Features
* add payload to jwt exception ([#521](https://github.com/firebase/php-jwt/issues/521)) ([175edf9](https://github.com/firebase/php-jwt/commit/175edf958bb61922ec135b2333acf5622f2238a2))
## [6.8.1](https://github.com/firebase/php-jwt/compare/v6.8.0...v6.8.1) (2023-07-14)
### Bug Fixes
* accept float claims but round down to ignore them ([#492](https://github.com/firebase/php-jwt/issues/492)) ([3936842](https://github.com/firebase/php-jwt/commit/39368423beeaacb3002afa7dcb75baebf204fe7e))
* different BeforeValidException messages for nbf and iat ([#526](https://github.com/firebase/php-jwt/issues/526)) ([0a53cf2](https://github.com/firebase/php-jwt/commit/0a53cf2986e45c2bcbf1a269f313ebf56a154ee4))
## [6.8.0](https://github.com/firebase/php-jwt/compare/v6.7.0...v6.8.0) (2023-06-14)
### Features
* add support for P-384 curve ([#515](https://github.com/firebase/php-jwt/issues/515)) ([5de4323](https://github.com/firebase/php-jwt/commit/5de4323f4baf4d70bca8663bd87682a69c656c3d))
### Bug Fixes
* handle invalid http responses ([#508](https://github.com/firebase/php-jwt/issues/508)) ([91c39c7](https://github.com/firebase/php-jwt/commit/91c39c72b22fc3e1191e574089552c1f2041c718))
## [6.7.0](https://github.com/firebase/php-jwt/compare/v6.6.0...v6.7.0) (2023-06-14)
### Features
* add ed25519 support to JWK (public keys) ([#452](https://github.com/firebase/php-jwt/issues/452)) ([e53979a](https://github.com/firebase/php-jwt/commit/e53979abae927de916a75b9d239cfda8ce32be2a))
## [6.6.0](https://github.com/firebase/php-jwt/compare/v6.5.0...v6.6.0) (2023-06-13)
### Features
* allow get headers when decoding token ([#442](https://github.com/firebase/php-jwt/issues/442)) ([fb85f47](https://github.com/firebase/php-jwt/commit/fb85f47cfaeffdd94faf8defdf07164abcdad6c3))
### Bug Fixes
* only check iat if nbf is not used ([#493](https://github.com/firebase/php-jwt/issues/493)) ([398ccd2](https://github.com/firebase/php-jwt/commit/398ccd25ea12fa84b9e4f1085d5ff448c21ec797))
## [6.5.0](https://github.com/firebase/php-jwt/compare/v6.4.0...v6.5.0) (2023-05-12)
### Bug Fixes
* allow KID of '0' ([#505](https://github.com/firebase/php-jwt/issues/505)) ([9dc46a9](https://github.com/firebase/php-jwt/commit/9dc46a9c3e5801294249cfd2554c5363c9f9326a))
### Miscellaneous Chores
* drop support for PHP 7.3 ([#495](https://github.com/firebase/php-jwt/issues/495))
## [6.4.0](https://github.com/firebase/php-jwt/compare/v6.3.2...v6.4.0) (2023-02-08)
### Features
* add support for W3C ES256K ([#462](https://github.com/firebase/php-jwt/issues/462)) ([213924f](https://github.com/firebase/php-jwt/commit/213924f51936291fbbca99158b11bd4ae56c2c95))
* improve caching by only decoding jwks when necessary ([#486](https://github.com/firebase/php-jwt/issues/486)) ([78d3ed1](https://github.com/firebase/php-jwt/commit/78d3ed1073553f7d0bbffa6c2010009a0d483d5c))
## [6.3.2](https://github.com/firebase/php-jwt/compare/v6.3.1...v6.3.2) (2022-11-01)
### Bug Fixes
* check kid before using as array index ([bad1b04](https://github.com/firebase/php-jwt/commit/bad1b040d0c736bbf86814c6b5ae614f517cf7bd))
## [6.3.1](https://github.com/firebase/php-jwt/compare/v6.3.0...v6.3.1) (2022-11-01)
### Bug Fixes
* casing of GET for PSR compat ([#451](https://github.com/firebase/php-jwt/issues/451)) ([60b52b7](https://github.com/firebase/php-jwt/commit/60b52b71978790eafcf3b95cfbd83db0439e8d22))
* string interpolation format for php 8.2 ([#446](https://github.com/firebase/php-jwt/issues/446)) ([2e07d8a](https://github.com/firebase/php-jwt/commit/2e07d8a1524d12b69b110ad649f17461d068b8f2))
## 6.3.0 / 2022-07-15
- Added ES256 support to JWK parsing ([#399](https://github.com/firebase/php-jwt/pull/399))
- Fixed potential caching error in `CachedKeySet` by caching jwks as strings ([#435](https://github.com/firebase/php-jwt/pull/435))
## 6.2.0 / 2022-05-14
- Added `CachedKeySet` ([#397](https://github.com/firebase/php-jwt/pull/397))
- Added `$defaultAlg` parameter to `JWT::parseKey` and `JWT::parseKeySet` ([#426](https://github.com/firebase/php-jwt/pull/426)).
## 6.1.0 / 2022-03-23
- Drop support for PHP 5.3, 5.4, 5.5, 5.6, and 7.0
- Add parameter typing and return types where possible
## 6.0.0 / 2022-01-24
- **Backwards-Compatibility Breaking Changes**: See the [Release Notes](https://github.com/firebase/php-jwt/releases/tag/v6.0.0) for more information.
- New Key object to prevent key/algorithm type confusion (#365)
- Add JWK support (#273)
- Add ES256 support (#256)
- Add ES384 support (#324)
- Add Ed25519 support (#343)
## 5.0.0 / 2017-06-26
- Support RS384 and RS512.
See [#117](https://github.com/firebase/php-jwt/pull/117). Thanks [@joostfaassen](https://github.com/joostfaassen)!
- Add an example for RS256 openssl.
See [#125](https://github.com/firebase/php-jwt/pull/125). Thanks [@akeeman](https://github.com/akeeman)!
- Detect invalid Base64 encoding in signature.
See [#162](https://github.com/firebase/php-jwt/pull/162). Thanks [@psignoret](https://github.com/psignoret)!
- Update `JWT::verify` to handle OpenSSL errors.
See [#159](https://github.com/firebase/php-jwt/pull/159). Thanks [@bshaffer](https://github.com/bshaffer)!
- Add `array` type hinting to `decode` method
See [#101](https://github.com/firebase/php-jwt/pull/101). Thanks [@hywak](https://github.com/hywak)!
- Add all JSON error types.
See [#110](https://github.com/firebase/php-jwt/pull/110). Thanks [@gbalduzzi](https://github.com/gbalduzzi)!
- Bugfix 'kid' not in given key list.
See [#129](https://github.com/firebase/php-jwt/pull/129). Thanks [@stampycode](https://github.com/stampycode)!
- Miscellaneous cleanup, documentation and test fixes.
See [#107](https://github.com/firebase/php-jwt/pull/107), [#115](https://github.com/firebase/php-jwt/pull/115),
[#160](https://github.com/firebase/php-jwt/pull/160), [#161](https://github.com/firebase/php-jwt/pull/161), and
[#165](https://github.com/firebase/php-jwt/pull/165). Thanks [@akeeman](https://github.com/akeeman),
[@chinedufn](https://github.com/chinedufn), and [@bshaffer](https://github.com/bshaffer)!
## 4.0.0 / 2016-07-17
- Add support for late static binding. See [#88](https://github.com/firebase/php-jwt/pull/88) for details. Thanks to [@chappy84](https://github.com/chappy84)!
- Use static `$timestamp` instead of `time()` to improve unit testing. See [#93](https://github.com/firebase/php-jwt/pull/93) for details. Thanks to [@josephmcdermott](https://github.com/josephmcdermott)!
- Fixes to exceptions classes. See [#81](https://github.com/firebase/php-jwt/pull/81) for details. Thanks to [@Maks3w](https://github.com/Maks3w)!
- Fixes to PHPDoc. See [#76](https://github.com/firebase/php-jwt/pull/76) for details. Thanks to [@akeeman](https://github.com/akeeman)!
## 3.0.0 / 2015-07-22
- Minimum PHP version updated from `5.2.0` to `5.3.0`.
- Add `\Firebase\JWT` namespace. See
[#59](https://github.com/firebase/php-jwt/pull/59) for details. Thanks to
[@Dashron](https://github.com/Dashron)!
- Require a non-empty key to decode and verify a JWT. See
[#60](https://github.com/firebase/php-jwt/pull/60) for details. Thanks to
[@sjones608](https://github.com/sjones608)!
- Cleaner documentation blocks in the code. See
[#62](https://github.com/firebase/php-jwt/pull/62) for details. Thanks to
[@johanderuijter](https://github.com/johanderuijter)!
## 2.2.0 / 2015-06-22
- Add support for adding custom, optional JWT headers to `JWT::encode()`. See
[#53](https://github.com/firebase/php-jwt/pull/53/files) for details. Thanks to
[@mcocaro](https://github.com/mcocaro)!
## 2.1.0 / 2015-05-20
- Add support for adding a leeway to `JWT:decode()` that accounts for clock skew
between signing and verifying entities. Thanks to [@lcabral](https://github.com/lcabral)!
- Add support for passing an object implementing the `ArrayAccess` interface for
`$keys` argument in `JWT::decode()`. Thanks to [@aztech-dev](https://github.com/aztech-dev)!
## 2.0.0 / 2015-04-01
- **Note**: It is strongly recommended that you update to > v2.0.0 to address
known security vulnerabilities in prior versions when both symmetric and
asymmetric keys are used together.
- Update signature for `JWT::decode(...)` to require an array of supported
algorithms to use when verifying token signatures.

View File

@@ -1,30 +0,0 @@
Copyright (c) 2011, Neuman Vong
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided
with the distribution.
* Neither the name of the copyright holder nor the names of other
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

View File

@@ -1,425 +0,0 @@
![Build Status](https://github.com/firebase/php-jwt/actions/workflows/tests.yml/badge.svg)
[![Latest Stable Version](https://poser.pugx.org/firebase/php-jwt/v/stable)](https://packagist.org/packages/firebase/php-jwt)
[![Total Downloads](https://poser.pugx.org/firebase/php-jwt/downloads)](https://packagist.org/packages/firebase/php-jwt)
[![License](https://poser.pugx.org/firebase/php-jwt/license)](https://packagist.org/packages/firebase/php-jwt)
PHP-JWT
=======
A simple library to encode and decode JSON Web Tokens (JWT) in PHP, conforming to [RFC 7519](https://tools.ietf.org/html/rfc7519).
Installation
------------
Use composer to manage your dependencies and download PHP-JWT:
```bash
composer require firebase/php-jwt
```
Optionally, install the `paragonie/sodium_compat` package from composer if your
php env does not have libsodium installed:
```bash
composer require paragonie/sodium_compat
```
Example
-------
```php
use Firebase\JWT\JWT;
use Firebase\JWT\Key;
$key = 'example_key';
$payload = [
'iss' => 'http://example.org',
'aud' => 'http://example.com',
'iat' => 1356999524,
'nbf' => 1357000000
];
/**
* IMPORTANT:
* You must specify supported algorithms for your application. See
* https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40
* for a list of spec-compliant algorithms.
*/
$jwt = JWT::encode($payload, $key, 'HS256');
$decoded = JWT::decode($jwt, new Key($key, 'HS256'));
print_r($decoded);
// Pass a stdClass in as the third parameter to get the decoded header values
$headers = new stdClass();
$decoded = JWT::decode($jwt, new Key($key, 'HS256'), $headers);
print_r($headers);
/*
NOTE: This will now be an object instead of an associative array. To get
an associative array, you will need to cast it as such:
*/
$decoded_array = (array) $decoded;
/**
* You can add a leeway to account for when there is a clock skew times between
* the signing and verifying servers. It is recommended that this leeway should
* not be bigger than a few minutes.
*
* Source: http://self-issued.info/docs/draft-ietf-oauth-json-web-token.html#nbfDef
*/
JWT::$leeway = 60; // $leeway in seconds
$decoded = JWT::decode($jwt, new Key($key, 'HS256'));
```
Example encode/decode headers
-------
Decoding the JWT headers without verifying the JWT first is NOT recommended, and is not supported by
this library. This is because without verifying the JWT, the header values could have been tampered with.
Any value pulled from an unverified header should be treated as if it could be any string sent in from an
attacker. If this is something you still want to do in your application for whatever reason, it's possible to
decode the header values manually simply by calling `json_decode` and `base64_decode` on the JWT
header part:
```php
use Firebase\JWT\JWT;
$key = 'example_key';
$payload = [
'iss' => 'http://example.org',
'aud' => 'http://example.com',
'iat' => 1356999524,
'nbf' => 1357000000
];
$headers = [
'x-forwarded-for' => 'www.google.com'
];
// Encode headers in the JWT string
$jwt = JWT::encode($payload, $key, 'HS256', null, $headers);
// Decode headers from the JWT string WITHOUT validation
// **IMPORTANT**: This operation is vulnerable to attacks, as the JWT has not yet been verified.
// These headers could be any value sent by an attacker.
list($headersB64, $payloadB64, $sig) = explode('.', $jwt);
$decoded = json_decode(base64_decode($headersB64), true);
print_r($decoded);
```
Example with RS256 (openssl)
----------------------------
```php
use Firebase\JWT\JWT;
use Firebase\JWT\Key;
$privateKey = <<<EOD
-----BEGIN RSA PRIVATE KEY-----
MIIEowIBAAKCAQEAuzWHNM5f+amCjQztc5QTfJfzCC5J4nuW+L/aOxZ4f8J3Frew
M2c/dufrnmedsApb0By7WhaHlcqCh/ScAPyJhzkPYLae7bTVro3hok0zDITR8F6S
JGL42JAEUk+ILkPI+DONM0+3vzk6Kvfe548tu4czCuqU8BGVOlnp6IqBHhAswNMM
78pos/2z0CjPM4tbeXqSTTbNkXRboxjU29vSopcT51koWOgiTf3C7nJUoMWZHZI5
HqnIhPAG9yv8HAgNk6CMk2CadVHDo4IxjxTzTTqo1SCSH2pooJl9O8at6kkRYsrZ
WwsKlOFE2LUce7ObnXsYihStBUDoeBQlGG/BwQIDAQABAoIBAFtGaOqNKGwggn9k
6yzr6GhZ6Wt2rh1Xpq8XUz514UBhPxD7dFRLpbzCrLVpzY80LbmVGJ9+1pJozyWc
VKeCeUdNwbqkr240Oe7GTFmGjDoxU+5/HX/SJYPpC8JZ9oqgEA87iz+WQX9hVoP2
oF6EB4ckDvXmk8FMwVZW2l2/kd5mrEVbDaXKxhvUDf52iVD+sGIlTif7mBgR99/b
c3qiCnxCMmfYUnT2eh7Vv2LhCR/G9S6C3R4lA71rEyiU3KgsGfg0d82/XWXbegJW
h3QbWNtQLxTuIvLq5aAryV3PfaHlPgdgK0ft6ocU2de2FagFka3nfVEyC7IUsNTK
bq6nhAECgYEA7d/0DPOIaItl/8BWKyCuAHMss47j0wlGbBSHdJIiS55akMvnAG0M
39y22Qqfzh1at9kBFeYeFIIU82ZLF3xOcE3z6pJZ4Dyvx4BYdXH77odo9uVK9s1l
3T3BlMcqd1hvZLMS7dviyH79jZo4CXSHiKzc7pQ2YfK5eKxKqONeXuECgYEAyXlG
vonaus/YTb1IBei9HwaccnQ/1HRn6MvfDjb7JJDIBhNClGPt6xRlzBbSZ73c2QEC
6Fu9h36K/HZ2qcLd2bXiNyhIV7b6tVKk+0Psoj0dL9EbhsD1OsmE1nTPyAc9XZbb
OPYxy+dpBCUA8/1U9+uiFoCa7mIbWcSQ+39gHuECgYAz82pQfct30aH4JiBrkNqP
nJfRq05UY70uk5k1u0ikLTRoVS/hJu/d4E1Kv4hBMqYCavFSwAwnvHUo51lVCr/y
xQOVYlsgnwBg2MX4+GjmIkqpSVCC8D7j/73MaWb746OIYZervQ8dbKahi2HbpsiG
8AHcVSA/agxZr38qvWV54QKBgCD5TlDE8x18AuTGQ9FjxAAd7uD0kbXNz2vUYg9L
hFL5tyL3aAAtUrUUw4xhd9IuysRhW/53dU+FsG2dXdJu6CxHjlyEpUJl2iZu/j15
YnMzGWHIEX8+eWRDsw/+Ujtko/B7TinGcWPz3cYl4EAOiCeDUyXnqnO1btCEUU44
DJ1BAoGBAJuPD27ErTSVtId90+M4zFPNibFP50KprVdc8CR37BE7r8vuGgNYXmnI
RLnGP9p3pVgFCktORuYS2J/6t84I3+A17nEoB4xvhTLeAinAW/uTQOUmNicOP4Ek
2MsLL2kHgL8bLTmvXV4FX+PXphrDKg1XxzOYn0otuoqdAQrkK4og
-----END RSA PRIVATE KEY-----
EOD;
$publicKey = <<<EOD
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuzWHNM5f+amCjQztc5QT
fJfzCC5J4nuW+L/aOxZ4f8J3FrewM2c/dufrnmedsApb0By7WhaHlcqCh/ScAPyJ
hzkPYLae7bTVro3hok0zDITR8F6SJGL42JAEUk+ILkPI+DONM0+3vzk6Kvfe548t
u4czCuqU8BGVOlnp6IqBHhAswNMM78pos/2z0CjPM4tbeXqSTTbNkXRboxjU29vS
opcT51koWOgiTf3C7nJUoMWZHZI5HqnIhPAG9yv8HAgNk6CMk2CadVHDo4IxjxTz
TTqo1SCSH2pooJl9O8at6kkRYsrZWwsKlOFE2LUce7ObnXsYihStBUDoeBQlGG/B
wQIDAQAB
-----END PUBLIC KEY-----
EOD;
$payload = [
'iss' => 'example.org',
'aud' => 'example.com',
'iat' => 1356999524,
'nbf' => 1357000000
];
$jwt = JWT::encode($payload, $privateKey, 'RS256');
echo "Encode:\n" . print_r($jwt, true) . "\n";
$decoded = JWT::decode($jwt, new Key($publicKey, 'RS256'));
/*
NOTE: This will now be an object instead of an associative array. To get
an associative array, you will need to cast it as such:
*/
$decoded_array = (array) $decoded;
echo "Decode:\n" . print_r($decoded_array, true) . "\n";
```
Example with a passphrase
-------------------------
```php
use Firebase\JWT\JWT;
use Firebase\JWT\Key;
// Your passphrase
$passphrase = '[YOUR_PASSPHRASE]';
// Your private key file with passphrase
// Can be generated with "ssh-keygen -t rsa -m pem"
$privateKeyFile = '/path/to/key-with-passphrase.pem';
// Create a private key of type "resource"
$privateKey = openssl_pkey_get_private(
file_get_contents($privateKeyFile),
$passphrase
);
$payload = [
'iss' => 'example.org',
'aud' => 'example.com',
'iat' => 1356999524,
'nbf' => 1357000000
];
$jwt = JWT::encode($payload, $privateKey, 'RS256');
echo "Encode:\n" . print_r($jwt, true) . "\n";
// Get public key from the private key, or pull from from a file.
$publicKey = openssl_pkey_get_details($privateKey)['key'];
$decoded = JWT::decode($jwt, new Key($publicKey, 'RS256'));
echo "Decode:\n" . print_r((array) $decoded, true) . "\n";
```
Example with EdDSA (libsodium and Ed25519 signature)
----------------------------
```php
use Firebase\JWT\JWT;
use Firebase\JWT\Key;
// Public and private keys are expected to be Base64 encoded. The last
// non-empty line is used so that keys can be generated with
// sodium_crypto_sign_keypair(). The secret keys generated by other tools may
// need to be adjusted to match the input expected by libsodium.
$keyPair = sodium_crypto_sign_keypair();
$privateKey = base64_encode(sodium_crypto_sign_secretkey($keyPair));
$publicKey = base64_encode(sodium_crypto_sign_publickey($keyPair));
$payload = [
'iss' => 'example.org',
'aud' => 'example.com',
'iat' => 1356999524,
'nbf' => 1357000000
];
$jwt = JWT::encode($payload, $privateKey, 'EdDSA');
echo "Encode:\n" . print_r($jwt, true) . "\n";
$decoded = JWT::decode($jwt, new Key($publicKey, 'EdDSA'));
echo "Decode:\n" . print_r((array) $decoded, true) . "\n";
````
Example with multiple keys
--------------------------
```php
use Firebase\JWT\JWT;
use Firebase\JWT\Key;
// Example RSA keys from previous example
// $privateKey1 = '...';
// $publicKey1 = '...';
// Example EdDSA keys from previous example
// $privateKey2 = '...';
// $publicKey2 = '...';
$payload = [
'iss' => 'example.org',
'aud' => 'example.com',
'iat' => 1356999524,
'nbf' => 1357000000
];
$jwt1 = JWT::encode($payload, $privateKey1, 'RS256', 'kid1');
$jwt2 = JWT::encode($payload, $privateKey2, 'EdDSA', 'kid2');
echo "Encode 1:\n" . print_r($jwt1, true) . "\n";
echo "Encode 2:\n" . print_r($jwt2, true) . "\n";
$keys = [
'kid1' => new Key($publicKey1, 'RS256'),
'kid2' => new Key($publicKey2, 'EdDSA'),
];
$decoded1 = JWT::decode($jwt1, $keys);
$decoded2 = JWT::decode($jwt2, $keys);
echo "Decode 1:\n" . print_r((array) $decoded1, true) . "\n";
echo "Decode 2:\n" . print_r((array) $decoded2, true) . "\n";
```
Using JWKs
----------
```php
use Firebase\JWT\JWK;
use Firebase\JWT\JWT;
// Set of keys. The "keys" key is required. For example, the JSON response to
// this endpoint: https://www.gstatic.com/iap/verify/public_key-jwk
$jwks = ['keys' => []];
// JWK::parseKeySet($jwks) returns an associative array of **kid** to Firebase\JWT\Key
// objects. Pass this as the second parameter to JWT::decode.
JWT::decode($jwt, JWK::parseKeySet($jwks));
```
Using Cached Key Sets
---------------------
The `CachedKeySet` class can be used to fetch and cache JWKS (JSON Web Key Sets) from a public URI.
This has the following advantages:
1. The results are cached for performance.
2. If an unrecognized key is requested, the cache is refreshed, to accomodate for key rotation.
3. If rate limiting is enabled, the JWKS URI will not make more than 10 requests a second.
```php
use Firebase\JWT\CachedKeySet;
use Firebase\JWT\JWT;
// The URI for the JWKS you wish to cache the results from
$jwksUri = 'https://www.gstatic.com/iap/verify/public_key-jwk';
// Create an HTTP client (can be any PSR-7 compatible HTTP client)
$httpClient = new GuzzleHttp\Client();
// Create an HTTP request factory (can be any PSR-17 compatible HTTP request factory)
$httpFactory = new GuzzleHttp\Psr\HttpFactory();
// Create a cache item pool (can be any PSR-6 compatible cache item pool)
$cacheItemPool = Phpfastcache\CacheManager::getInstance('files');
$keySet = new CachedKeySet(
$jwksUri,
$httpClient,
$httpFactory,
$cacheItemPool,
null, // $expiresAfter int seconds to set the JWKS to expire
true // $rateLimit true to enable rate limit of 10 RPS on lookup of invalid keys
);
$jwt = 'eyJhbGci...'; // Some JWT signed by a key from the $jwkUri above
$decoded = JWT::decode($jwt, $keySet);
```
Miscellaneous
-------------
#### Exception Handling
When a call to `JWT::decode` is invalid, it will throw one of the following exceptions:
```php
use Firebase\JWT\JWT;
use Firebase\JWT\SignatureInvalidException;
use Firebase\JWT\BeforeValidException;
use Firebase\JWT\ExpiredException;
use DomainException;
use InvalidArgumentException;
use UnexpectedValueException;
try {
$decoded = JWT::decode($jwt, $keys);
} catch (InvalidArgumentException $e) {
// provided key/key-array is empty or malformed.
} catch (DomainException $e) {
// provided algorithm is unsupported OR
// provided key is invalid OR
// unknown error thrown in openSSL or libsodium OR
// libsodium is required but not available.
} catch (SignatureInvalidException $e) {
// provided JWT signature verification failed.
} catch (BeforeValidException $e) {
// provided JWT is trying to be used before "nbf" claim OR
// provided JWT is trying to be used before "iat" claim.
} catch (ExpiredException $e) {
// provided JWT is trying to be used after "exp" claim.
} catch (UnexpectedValueException $e) {
// provided JWT is malformed OR
// provided JWT is missing an algorithm / using an unsupported algorithm OR
// provided JWT algorithm does not match provided key OR
// provided key ID in key/key-array is empty or invalid.
}
```
All exceptions in the `Firebase\JWT` namespace extend `UnexpectedValueException`, and can be simplified
like this:
```php
use Firebase\JWT\JWT;
use UnexpectedValueException;
try {
$decoded = JWT::decode($jwt, $keys);
} catch (LogicException $e) {
// errors having to do with environmental setup or malformed JWT Keys
} catch (UnexpectedValueException $e) {
// errors having to do with JWT signature and claims
}
```
#### Casting to array
The return value of `JWT::decode` is the generic PHP object `stdClass`. If you'd like to handle with arrays
instead, you can do the following:
```php
// return type is stdClass
$decoded = JWT::decode($jwt, $keys);
// cast to array
$decoded = json_decode(json_encode($decoded), true);
```
Tests
-----
Run the tests using phpunit:
```bash
$ pear install PHPUnit
$ phpunit --configuration phpunit.xml.dist
PHPUnit 3.7.10 by Sebastian Bergmann.
.....
Time: 0 seconds, Memory: 2.50Mb
OK (5 tests, 5 assertions)
```
New Lines in private keys
-----
If your private key contains `\n` characters, be sure to wrap it in double quotes `""`
and not single quotes `''` in order to properly interpret the escaped characters.
License
-------
[3-Clause BSD](http://opensource.org/licenses/BSD-3-Clause).

View File

@@ -1,42 +0,0 @@
{
"name": "firebase/php-jwt",
"description": "A simple library to encode and decode JSON Web Tokens (JWT) in PHP. Should conform to the current spec.",
"homepage": "https://github.com/firebase/php-jwt",
"keywords": [
"php",
"jwt"
],
"authors": [
{
"name": "Neuman Vong",
"email": "neuman+pear@twilio.com",
"role": "Developer"
},
{
"name": "Anant Narayanan",
"email": "anant@php.net",
"role": "Developer"
}
],
"license": "BSD-3-Clause",
"require": {
"php": "^8.0"
},
"suggest": {
"paragonie/sodium_compat": "Support EdDSA (Ed25519) signatures when libsodium is not present",
"ext-sodium": "Support EdDSA (Ed25519) signatures"
},
"autoload": {
"psr-4": {
"Firebase\\JWT\\": "src"
}
},
"require-dev": {
"guzzlehttp/guzzle": "^7.4",
"phpspec/prophecy-phpunit": "^2.0",
"phpunit/phpunit": "^9.5",
"psr/cache": "^2.0||^3.0",
"psr/http-client": "^1.0",
"psr/http-factory": "^1.0"
}
}

View File

@@ -1,18 +0,0 @@
<?php
namespace Firebase\JWT;
class BeforeValidException extends \UnexpectedValueException implements JWTExceptionWithPayloadInterface
{
private object $payload;
public function setPayload(object $payload): void
{
$this->payload = $payload;
}
public function getPayload(): object
{
return $this->payload;
}
}

View File

@@ -1,274 +0,0 @@
<?php
namespace Firebase\JWT;
use ArrayAccess;
use InvalidArgumentException;
use LogicException;
use OutOfBoundsException;
use Psr\Cache\CacheItemInterface;
use Psr\Cache\CacheItemPoolInterface;
use Psr\Http\Client\ClientInterface;
use Psr\Http\Message\RequestFactoryInterface;
use RuntimeException;
use UnexpectedValueException;
/**
* @implements ArrayAccess<string, Key>
*/
class CachedKeySet implements ArrayAccess
{
/**
* @var string
*/
private $jwksUri;
/**
* @var ClientInterface
*/
private $httpClient;
/**
* @var RequestFactoryInterface
*/
private $httpFactory;
/**
* @var CacheItemPoolInterface
*/
private $cache;
/**
* @var ?int
*/
private $expiresAfter;
/**
* @var ?CacheItemInterface
*/
private $cacheItem;
/**
* @var array<string, array<mixed>>
*/
private $keySet;
/**
* @var string
*/
private $cacheKey;
/**
* @var string
*/
private $cacheKeyPrefix = 'jwks';
/**
* @var int
*/
private $maxKeyLength = 64;
/**
* @var bool
*/
private $rateLimit;
/**
* @var string
*/
private $rateLimitCacheKey;
/**
* @var int
*/
private $maxCallsPerMinute = 10;
/**
* @var string|null
*/
private $defaultAlg;
public function __construct(
string $jwksUri,
ClientInterface $httpClient,
RequestFactoryInterface $httpFactory,
CacheItemPoolInterface $cache,
?int $expiresAfter = null,
bool $rateLimit = false,
?string $defaultAlg = null
) {
$this->jwksUri = $jwksUri;
$this->httpClient = $httpClient;
$this->httpFactory = $httpFactory;
$this->cache = $cache;
$this->expiresAfter = $expiresAfter;
$this->rateLimit = $rateLimit;
$this->defaultAlg = $defaultAlg;
$this->setCacheKeys();
}
/**
* @param string $keyId
* @return Key
*/
public function offsetGet($keyId): Key
{
if (!$this->keyIdExists($keyId)) {
throw new OutOfBoundsException('Key ID not found');
}
return JWK::parseKey($this->keySet[$keyId], $this->defaultAlg);
}
/**
* @param string $keyId
* @return bool
*/
public function offsetExists($keyId): bool
{
return $this->keyIdExists($keyId);
}
/**
* @param string $offset
* @param Key $value
*/
public function offsetSet($offset, $value): void
{
throw new LogicException('Method not implemented');
}
/**
* @param string $offset
*/
public function offsetUnset($offset): void
{
throw new LogicException('Method not implemented');
}
/**
* @return array<mixed>
*/
private function formatJwksForCache(string $jwks): array
{
$jwks = json_decode($jwks, true);
if (!isset($jwks['keys'])) {
throw new UnexpectedValueException('"keys" member must exist in the JWK Set');
}
if (empty($jwks['keys'])) {
throw new InvalidArgumentException('JWK Set did not contain any keys');
}
$keys = [];
foreach ($jwks['keys'] as $k => $v) {
$kid = isset($v['kid']) ? $v['kid'] : $k;
$keys[(string) $kid] = $v;
}
return $keys;
}
private function keyIdExists(string $keyId): bool
{
if (null === $this->keySet) {
$item = $this->getCacheItem();
// Try to load keys from cache
if ($item->isHit()) {
// item found! retrieve it
$this->keySet = $item->get();
// If the cached item is a string, the JWKS response was cached (previous behavior).
// Parse this into expected format array<kid, jwk> instead.
if (\is_string($this->keySet)) {
$this->keySet = $this->formatJwksForCache($this->keySet);
}
}
}
if (!isset($this->keySet[$keyId])) {
if ($this->rateLimitExceeded()) {
return false;
}
$request = $this->httpFactory->createRequest('GET', $this->jwksUri);
$jwksResponse = $this->httpClient->sendRequest($request);
if ($jwksResponse->getStatusCode() !== 200) {
throw new UnexpectedValueException(
\sprintf('HTTP Error: %d %s for URI "%s"',
$jwksResponse->getStatusCode(),
$jwksResponse->getReasonPhrase(),
$this->jwksUri,
),
$jwksResponse->getStatusCode()
);
}
$this->keySet = $this->formatJwksForCache((string) $jwksResponse->getBody());
if (!isset($this->keySet[$keyId])) {
return false;
}
$item = $this->getCacheItem();
$item->set($this->keySet);
if ($this->expiresAfter) {
$item->expiresAfter($this->expiresAfter);
}
$this->cache->save($item);
}
return true;
}
private function rateLimitExceeded(): bool
{
if (!$this->rateLimit) {
return false;
}
$cacheItem = $this->cache->getItem($this->rateLimitCacheKey);
$cacheItemData = [];
if ($cacheItem->isHit() && \is_array($data = $cacheItem->get())) {
$cacheItemData = $data;
}
$callsPerMinute = $cacheItemData['callsPerMinute'] ?? 0;
$expiry = $cacheItemData['expiry'] ?? new \DateTime('+60 seconds', new \DateTimeZone('UTC'));
if (++$callsPerMinute > $this->maxCallsPerMinute) {
return true;
}
$cacheItem->set(['expiry' => $expiry, 'callsPerMinute' => $callsPerMinute]);
$cacheItem->expiresAt($expiry);
$this->cache->save($cacheItem);
return false;
}
private function getCacheItem(): CacheItemInterface
{
if (\is_null($this->cacheItem)) {
$this->cacheItem = $this->cache->getItem($this->cacheKey);
}
return $this->cacheItem;
}
private function setCacheKeys(): void
{
if (empty($this->jwksUri)) {
throw new RuntimeException('JWKS URI is empty');
}
// ensure we do not have illegal characters
$key = preg_replace('|[^a-zA-Z0-9_\.!]|', '', $this->jwksUri);
// add prefix
$key = $this->cacheKeyPrefix . $key;
// Hash keys if they exceed $maxKeyLength of 64
if (\strlen($key) > $this->maxKeyLength) {
$key = substr(hash('sha256', $key), 0, $this->maxKeyLength);
}
$this->cacheKey = $key;
if ($this->rateLimit) {
// add prefix
$rateLimitKey = $this->cacheKeyPrefix . 'ratelimit' . $key;
// Hash keys if they exceed $maxKeyLength of 64
if (\strlen($rateLimitKey) > $this->maxKeyLength) {
$rateLimitKey = substr(hash('sha256', $rateLimitKey), 0, $this->maxKeyLength);
}
$this->rateLimitCacheKey = $rateLimitKey;
}
}
}

View File

@@ -1,18 +0,0 @@
<?php
namespace Firebase\JWT;
class ExpiredException extends \UnexpectedValueException implements JWTExceptionWithPayloadInterface
{
private object $payload;
public function setPayload(object $payload): void
{
$this->payload = $payload;
}
public function getPayload(): object
{
return $this->payload;
}
}

View File

@@ -1,355 +0,0 @@
<?php
namespace Firebase\JWT;
use DomainException;
use InvalidArgumentException;
use UnexpectedValueException;
/**
* JSON Web Key implementation, based on this spec:
* https://tools.ietf.org/html/draft-ietf-jose-json-web-key-41
*
* PHP version 5
*
* @category Authentication
* @package Authentication_JWT
* @author Bui Sy Nguyen <nguyenbs@gmail.com>
* @license http://opensource.org/licenses/BSD-3-Clause 3-clause BSD
* @link https://github.com/firebase/php-jwt
*/
class JWK
{
private const OID = '1.2.840.10045.2.1';
private const ASN1_OBJECT_IDENTIFIER = 0x06;
private const ASN1_SEQUENCE = 0x10; // also defined in JWT
private const ASN1_BIT_STRING = 0x03;
private const EC_CURVES = [
'P-256' => '1.2.840.10045.3.1.7', // Len: 64
'secp256k1' => '1.3.132.0.10', // Len: 64
'P-384' => '1.3.132.0.34', // Len: 96
// 'P-521' => '1.3.132.0.35', // Len: 132 (not supported)
];
// For keys with "kty" equal to "OKP" (Octet Key Pair), the "crv" parameter must contain the key subtype.
// This library supports the following subtypes:
private const OKP_SUBTYPES = [
'Ed25519' => true, // RFC 8037
];
/**
* Parse a set of JWK keys
*
* @param array<mixed> $jwks The JSON Web Key Set as an associative array
* @param string $defaultAlg The algorithm for the Key object if "alg" is not set in the
* JSON Web Key Set
*
* @return array<string, Key> An associative array of key IDs (kid) to Key objects
*
* @throws InvalidArgumentException Provided JWK Set is empty
* @throws UnexpectedValueException Provided JWK Set was invalid
* @throws DomainException OpenSSL failure
*
* @uses parseKey
*/
public static function parseKeySet(array $jwks, ?string $defaultAlg = null): array
{
$keys = [];
if (!isset($jwks['keys'])) {
throw new UnexpectedValueException('"keys" member must exist in the JWK Set');
}
if (empty($jwks['keys'])) {
throw new InvalidArgumentException('JWK Set did not contain any keys');
}
foreach ($jwks['keys'] as $k => $v) {
$kid = isset($v['kid']) ? $v['kid'] : $k;
if ($key = self::parseKey($v, $defaultAlg)) {
$keys[(string) $kid] = $key;
}
}
if (0 === \count($keys)) {
throw new UnexpectedValueException('No supported algorithms found in JWK Set');
}
return $keys;
}
/**
* Parse a JWK key
*
* @param array<mixed> $jwk An individual JWK
* @param string $defaultAlg The algorithm for the Key object if "alg" is not set in the
* JSON Web Key Set
*
* @return Key The key object for the JWK
*
* @throws InvalidArgumentException Provided JWK is empty
* @throws UnexpectedValueException Provided JWK was invalid
* @throws DomainException OpenSSL failure
*
* @uses createPemFromModulusAndExponent
*/
public static function parseKey(array $jwk, ?string $defaultAlg = null): ?Key
{
if (empty($jwk)) {
throw new InvalidArgumentException('JWK must not be empty');
}
if (!isset($jwk['kty'])) {
throw new UnexpectedValueException('JWK must contain a "kty" parameter');
}
if (!isset($jwk['alg'])) {
if (\is_null($defaultAlg)) {
// The "alg" parameter is optional in a KTY, but an algorithm is required
// for parsing in this library. Use the $defaultAlg parameter when parsing the
// key set in order to prevent this error.
// @see https://datatracker.ietf.org/doc/html/rfc7517#section-4.4
throw new UnexpectedValueException('JWK must contain an "alg" parameter');
}
$jwk['alg'] = $defaultAlg;
}
switch ($jwk['kty']) {
case 'RSA':
if (!empty($jwk['d'])) {
throw new UnexpectedValueException('RSA private keys are not supported');
}
if (!isset($jwk['n']) || !isset($jwk['e'])) {
throw new UnexpectedValueException('RSA keys must contain values for both "n" and "e"');
}
$pem = self::createPemFromModulusAndExponent($jwk['n'], $jwk['e']);
$publicKey = \openssl_pkey_get_public($pem);
if (false === $publicKey) {
throw new DomainException(
'OpenSSL error: ' . \openssl_error_string()
);
}
return new Key($publicKey, $jwk['alg']);
case 'EC':
if (isset($jwk['d'])) {
// The key is actually a private key
throw new UnexpectedValueException('Key data must be for a public key');
}
if (empty($jwk['crv'])) {
throw new UnexpectedValueException('crv not set');
}
if (!isset(self::EC_CURVES[$jwk['crv']])) {
throw new DomainException('Unrecognised or unsupported EC curve');
}
if (empty($jwk['x']) || empty($jwk['y'])) {
throw new UnexpectedValueException('x and y not set');
}
$publicKey = self::createPemFromCrvAndXYCoordinates($jwk['crv'], $jwk['x'], $jwk['y']);
return new Key($publicKey, $jwk['alg']);
case 'OKP':
if (isset($jwk['d'])) {
// The key is actually a private key
throw new UnexpectedValueException('Key data must be for a public key');
}
if (!isset($jwk['crv'])) {
throw new UnexpectedValueException('crv not set');
}
if (empty(self::OKP_SUBTYPES[$jwk['crv']])) {
throw new DomainException('Unrecognised or unsupported OKP key subtype');
}
if (empty($jwk['x'])) {
throw new UnexpectedValueException('x not set');
}
// This library works internally with EdDSA keys (Ed25519) encoded in standard base64.
$publicKey = JWT::convertBase64urlToBase64($jwk['x']);
return new Key($publicKey, $jwk['alg']);
case 'oct':
if (!isset($jwk['k'])) {
throw new UnexpectedValueException('k not set');
}
return new Key(JWT::urlsafeB64Decode($jwk['k']), $jwk['alg']);
default:
break;
}
return null;
}
/**
* Converts the EC JWK values to pem format.
*
* @param string $crv The EC curve (only P-256 & P-384 is supported)
* @param string $x The EC x-coordinate
* @param string $y The EC y-coordinate
*
* @return string
*/
private static function createPemFromCrvAndXYCoordinates(string $crv, string $x, string $y): string
{
$pem =
self::encodeDER(
self::ASN1_SEQUENCE,
self::encodeDER(
self::ASN1_SEQUENCE,
self::encodeDER(
self::ASN1_OBJECT_IDENTIFIER,
self::encodeOID(self::OID)
)
. self::encodeDER(
self::ASN1_OBJECT_IDENTIFIER,
self::encodeOID(self::EC_CURVES[$crv])
)
) .
self::encodeDER(
self::ASN1_BIT_STRING,
\chr(0x00) . \chr(0x04)
. JWT::urlsafeB64Decode($x)
. JWT::urlsafeB64Decode($y)
)
);
return \sprintf(
"-----BEGIN PUBLIC KEY-----\n%s\n-----END PUBLIC KEY-----\n",
wordwrap(base64_encode($pem), 64, "\n", true)
);
}
/**
* Create a public key represented in PEM format from RSA modulus and exponent information
*
* @param string $n The RSA modulus encoded in Base64
* @param string $e The RSA exponent encoded in Base64
*
* @return string The RSA public key represented in PEM format
*
* @uses encodeLength
*/
private static function createPemFromModulusAndExponent(
string $n,
string $e
): string {
$mod = JWT::urlsafeB64Decode($n);
$exp = JWT::urlsafeB64Decode($e);
$modulus = \pack('Ca*a*', 2, self::encodeLength(\strlen($mod)), $mod);
$publicExponent = \pack('Ca*a*', 2, self::encodeLength(\strlen($exp)), $exp);
$rsaPublicKey = \pack(
'Ca*a*a*',
48,
self::encodeLength(\strlen($modulus) + \strlen($publicExponent)),
$modulus,
$publicExponent
);
// sequence(oid(1.2.840.113549.1.1.1), null)) = rsaEncryption.
$rsaOID = \pack('H*', '300d06092a864886f70d0101010500'); // hex version of MA0GCSqGSIb3DQEBAQUA
$rsaPublicKey = \chr(0) . $rsaPublicKey;
$rsaPublicKey = \chr(3) . self::encodeLength(\strlen($rsaPublicKey)) . $rsaPublicKey;
$rsaPublicKey = \pack(
'Ca*a*',
48,
self::encodeLength(\strlen($rsaOID . $rsaPublicKey)),
$rsaOID . $rsaPublicKey
);
return "-----BEGIN PUBLIC KEY-----\r\n" .
\chunk_split(\base64_encode($rsaPublicKey), 64) .
'-----END PUBLIC KEY-----';
}
/**
* DER-encode the length
*
* DER supports lengths up to (2**8)**127, however, we'll only support lengths up to (2**8)**4. See
* {@link http://itu.int/ITU-T/studygroups/com17/languages/X.690-0207.pdf#p=13 X.690 paragraph 8.1.3} for more information.
*
* @param int $length
* @return string
*/
private static function encodeLength(int $length): string
{
if ($length <= 0x7F) {
return \chr($length);
}
$temp = \ltrim(\pack('N', $length), \chr(0));
return \pack('Ca*', 0x80 | \strlen($temp), $temp);
}
/**
* Encodes a value into a DER object.
* Also defined in Firebase\JWT\JWT
*
* @param int $type DER tag
* @param string $value the value to encode
* @return string the encoded object
*/
private static function encodeDER(int $type, string $value): string
{
$tag_header = 0;
if ($type === self::ASN1_SEQUENCE) {
$tag_header |= 0x20;
}
// Type
$der = \chr($tag_header | $type);
// Length
$der .= \chr(\strlen($value));
return $der . $value;
}
/**
* Encodes a string into a DER-encoded OID.
*
* @param string $oid the OID string
* @return string the binary DER-encoded OID
*/
private static function encodeOID(string $oid): string
{
$octets = explode('.', $oid);
// Get the first octet
$first = (int) array_shift($octets);
$second = (int) array_shift($octets);
$oid = \chr($first * 40 + $second);
// Iterate over subsequent octets
foreach ($octets as $octet) {
if ($octet == 0) {
$oid .= \chr(0x00);
continue;
}
$bin = '';
while ($octet) {
$bin .= \chr(0x80 | ($octet & 0x7f));
$octet >>= 7;
}
$bin[0] = $bin[0] & \chr(0x7f);
// Convert to big endian if necessary
if (pack('V', 65534) == pack('L', 65534)) {
$oid .= strrev($bin);
} else {
$oid .= $bin;
}
}
return $oid;
}
}

View File

@@ -1,667 +0,0 @@
<?php
namespace Firebase\JWT;
use ArrayAccess;
use DateTime;
use DomainException;
use Exception;
use InvalidArgumentException;
use OpenSSLAsymmetricKey;
use OpenSSLCertificate;
use stdClass;
use UnexpectedValueException;
/**
* JSON Web Token implementation, based on this spec:
* https://tools.ietf.org/html/rfc7519
*
* PHP version 5
*
* @category Authentication
* @package Authentication_JWT
* @author Neuman Vong <neuman@twilio.com>
* @author Anant Narayanan <anant@php.net>
* @license http://opensource.org/licenses/BSD-3-Clause 3-clause BSD
* @link https://github.com/firebase/php-jwt
*/
class JWT
{
private const ASN1_INTEGER = 0x02;
private const ASN1_SEQUENCE = 0x10;
private const ASN1_BIT_STRING = 0x03;
/**
* When checking nbf, iat or expiration times,
* we want to provide some extra leeway time to
* account for clock skew.
*
* @var int
*/
public static $leeway = 0;
/**
* Allow the current timestamp to be specified.
* Useful for fixing a value within unit testing.
* Will default to PHP time() value if null.
*
* @var ?int
*/
public static $timestamp = null;
/**
* @var array<string, string[]>
*/
public static $supported_algs = [
'ES384' => ['openssl', 'SHA384'],
'ES256' => ['openssl', 'SHA256'],
'ES256K' => ['openssl', 'SHA256'],
'HS256' => ['hash_hmac', 'SHA256'],
'HS384' => ['hash_hmac', 'SHA384'],
'HS512' => ['hash_hmac', 'SHA512'],
'RS256' => ['openssl', 'SHA256'],
'RS384' => ['openssl', 'SHA384'],
'RS512' => ['openssl', 'SHA512'],
'EdDSA' => ['sodium_crypto', 'EdDSA'],
];
/**
* Decodes a JWT string into a PHP object.
*
* @param string $jwt The JWT
* @param Key|ArrayAccess<string,Key>|array<string,Key> $keyOrKeyArray The Key or associative array of key IDs
* (kid) to Key objects.
* If the algorithm used is asymmetric, this is
* the public key.
* Each Key object contains an algorithm and
* matching key.
* Supported algorithms are 'ES384','ES256',
* 'HS256', 'HS384', 'HS512', 'RS256', 'RS384'
* and 'RS512'.
* @param stdClass $headers Optional. Populates stdClass with headers.
*
* @return stdClass The JWT's payload as a PHP object
*
* @throws InvalidArgumentException Provided key/key-array was empty or malformed
* @throws DomainException Provided JWT is malformed
* @throws UnexpectedValueException Provided JWT was invalid
* @throws SignatureInvalidException Provided JWT was invalid because the signature verification failed
* @throws BeforeValidException Provided JWT is trying to be used before it's eligible as defined by 'nbf'
* @throws BeforeValidException Provided JWT is trying to be used before it's been created as defined by 'iat'
* @throws ExpiredException Provided JWT has since expired, as defined by the 'exp' claim
*
* @uses jsonDecode
* @uses urlsafeB64Decode
*/
public static function decode(
string $jwt,
$keyOrKeyArray,
?stdClass &$headers = null
): stdClass {
// Validate JWT
$timestamp = \is_null(static::$timestamp) ? \time() : static::$timestamp;
if (empty($keyOrKeyArray)) {
throw new InvalidArgumentException('Key may not be empty');
}
$tks = \explode('.', $jwt);
if (\count($tks) !== 3) {
throw new UnexpectedValueException('Wrong number of segments');
}
list($headb64, $bodyb64, $cryptob64) = $tks;
$headerRaw = static::urlsafeB64Decode($headb64);
if (null === ($header = static::jsonDecode($headerRaw))) {
throw new UnexpectedValueException('Invalid header encoding');
}
if ($headers !== null) {
$headers = $header;
}
$payloadRaw = static::urlsafeB64Decode($bodyb64);
if (null === ($payload = static::jsonDecode($payloadRaw))) {
throw new UnexpectedValueException('Invalid claims encoding');
}
if (\is_array($payload)) {
// prevent PHP Fatal Error in edge-cases when payload is empty array
$payload = (object) $payload;
}
if (!$payload instanceof stdClass) {
throw new UnexpectedValueException('Payload must be a JSON object');
}
$sig = static::urlsafeB64Decode($cryptob64);
if (empty($header->alg)) {
throw new UnexpectedValueException('Empty algorithm');
}
if (empty(static::$supported_algs[$header->alg])) {
throw new UnexpectedValueException('Algorithm not supported');
}
$key = self::getKey($keyOrKeyArray, property_exists($header, 'kid') ? $header->kid : null);
// Check the algorithm
if (!self::constantTimeEquals($key->getAlgorithm(), $header->alg)) {
// See issue #351
throw new UnexpectedValueException('Incorrect key for this algorithm');
}
if (\in_array($header->alg, ['ES256', 'ES256K', 'ES384'], true)) {
// OpenSSL expects an ASN.1 DER sequence for ES256/ES256K/ES384 signatures
$sig = self::signatureToDER($sig);
}
if (!self::verify("{$headb64}.{$bodyb64}", $sig, $key->getKeyMaterial(), $header->alg)) {
throw new SignatureInvalidException('Signature verification failed');
}
// Check the nbf if it is defined. This is the time that the
// token can actually be used. If it's not yet that time, abort.
if (isset($payload->nbf) && floor($payload->nbf) > ($timestamp + static::$leeway)) {
$ex = new BeforeValidException(
'Cannot handle token with nbf prior to ' . \date(DateTime::ISO8601, (int) floor($payload->nbf))
);
$ex->setPayload($payload);
throw $ex;
}
// Check that this token has been created before 'now'. This prevents
// using tokens that have been created for later use (and haven't
// correctly used the nbf claim).
if (!isset($payload->nbf) && isset($payload->iat) && floor($payload->iat) > ($timestamp + static::$leeway)) {
$ex = new BeforeValidException(
'Cannot handle token with iat prior to ' . \date(DateTime::ISO8601, (int) floor($payload->iat))
);
$ex->setPayload($payload);
throw $ex;
}
// Check if this token has expired.
if (isset($payload->exp) && ($timestamp - static::$leeway) >= $payload->exp) {
$ex = new ExpiredException('Expired token');
$ex->setPayload($payload);
throw $ex;
}
return $payload;
}
/**
* Converts and signs a PHP array into a JWT string.
*
* @param array<mixed> $payload PHP array
* @param string|resource|OpenSSLAsymmetricKey|OpenSSLCertificate $key The secret key.
* @param string $alg Supported algorithms are 'ES384','ES256', 'ES256K', 'HS256',
* 'HS384', 'HS512', 'RS256', 'RS384', and 'RS512'
* @param string $keyId
* @param array<string, string> $head An array with header elements to attach
*
* @return string A signed JWT
*
* @uses jsonEncode
* @uses urlsafeB64Encode
*/
public static function encode(
array $payload,
$key,
string $alg,
?string $keyId = null,
?array $head = null
): string {
$header = ['typ' => 'JWT'];
if (isset($head)) {
$header = \array_merge($header, $head);
}
$header['alg'] = $alg;
if ($keyId !== null) {
$header['kid'] = $keyId;
}
$segments = [];
$segments[] = static::urlsafeB64Encode((string) static::jsonEncode($header));
$segments[] = static::urlsafeB64Encode((string) static::jsonEncode($payload));
$signing_input = \implode('.', $segments);
$signature = static::sign($signing_input, $key, $alg);
$segments[] = static::urlsafeB64Encode($signature);
return \implode('.', $segments);
}
/**
* Sign a string with a given key and algorithm.
*
* @param string $msg The message to sign
* @param string|resource|OpenSSLAsymmetricKey|OpenSSLCertificate $key The secret key.
* @param string $alg Supported algorithms are 'EdDSA', 'ES384', 'ES256', 'ES256K', 'HS256',
* 'HS384', 'HS512', 'RS256', 'RS384', and 'RS512'
*
* @return string An encrypted message
*
* @throws DomainException Unsupported algorithm or bad key was specified
*/
public static function sign(
string $msg,
$key,
string $alg
): string {
if (empty(static::$supported_algs[$alg])) {
throw new DomainException('Algorithm not supported');
}
list($function, $algorithm) = static::$supported_algs[$alg];
switch ($function) {
case 'hash_hmac':
if (!\is_string($key)) {
throw new InvalidArgumentException('key must be a string when using hmac');
}
return \hash_hmac($algorithm, $msg, $key, true);
case 'openssl':
$signature = '';
if (!\is_resource($key) && !openssl_pkey_get_private($key)) {
throw new DomainException('OpenSSL unable to validate key');
}
$success = \openssl_sign($msg, $signature, $key, $algorithm); // @phpstan-ignore-line
if (!$success) {
throw new DomainException('OpenSSL unable to sign data');
}
if ($alg === 'ES256' || $alg === 'ES256K') {
$signature = self::signatureFromDER($signature, 256);
} elseif ($alg === 'ES384') {
$signature = self::signatureFromDER($signature, 384);
}
return $signature;
case 'sodium_crypto':
if (!\function_exists('sodium_crypto_sign_detached')) {
throw new DomainException('libsodium is not available');
}
if (!\is_string($key)) {
throw new InvalidArgumentException('key must be a string when using EdDSA');
}
try {
// The last non-empty line is used as the key.
$lines = array_filter(explode("\n", $key));
$key = base64_decode((string) end($lines));
if (\strlen($key) === 0) {
throw new DomainException('Key cannot be empty string');
}
return sodium_crypto_sign_detached($msg, $key);
} catch (Exception $e) {
throw new DomainException($e->getMessage(), 0, $e);
}
}
throw new DomainException('Algorithm not supported');
}
/**
* Verify a signature with the message, key and method. Not all methods
* are symmetric, so we must have a separate verify and sign method.
*
* @param string $msg The original message (header and body)
* @param string $signature The original signature
* @param string|resource|OpenSSLAsymmetricKey|OpenSSLCertificate $keyMaterial For Ed*, ES*, HS*, a string key works. for RS*, must be an instance of OpenSSLAsymmetricKey
* @param string $alg The algorithm
*
* @return bool
*
* @throws DomainException Invalid Algorithm, bad key, or OpenSSL failure
*/
private static function verify(
string $msg,
string $signature,
$keyMaterial,
string $alg
): bool {
if (empty(static::$supported_algs[$alg])) {
throw new DomainException('Algorithm not supported');
}
list($function, $algorithm) = static::$supported_algs[$alg];
switch ($function) {
case 'openssl':
$success = \openssl_verify($msg, $signature, $keyMaterial, $algorithm); // @phpstan-ignore-line
if ($success === 1) {
return true;
}
if ($success === 0) {
return false;
}
// returns 1 on success, 0 on failure, -1 on error.
throw new DomainException(
'OpenSSL error: ' . \openssl_error_string()
);
case 'sodium_crypto':
if (!\function_exists('sodium_crypto_sign_verify_detached')) {
throw new DomainException('libsodium is not available');
}
if (!\is_string($keyMaterial)) {
throw new InvalidArgumentException('key must be a string when using EdDSA');
}
try {
// The last non-empty line is used as the key.
$lines = array_filter(explode("\n", $keyMaterial));
$key = base64_decode((string) end($lines));
if (\strlen($key) === 0) {
throw new DomainException('Key cannot be empty string');
}
if (\strlen($signature) === 0) {
throw new DomainException('Signature cannot be empty string');
}
return sodium_crypto_sign_verify_detached($signature, $msg, $key);
} catch (Exception $e) {
throw new DomainException($e->getMessage(), 0, $e);
}
case 'hash_hmac':
default:
if (!\is_string($keyMaterial)) {
throw new InvalidArgumentException('key must be a string when using hmac');
}
$hash = \hash_hmac($algorithm, $msg, $keyMaterial, true);
return self::constantTimeEquals($hash, $signature);
}
}
/**
* Decode a JSON string into a PHP object.
*
* @param string $input JSON string
*
* @return mixed The decoded JSON string
*
* @throws DomainException Provided string was invalid JSON
*/
public static function jsonDecode(string $input)
{
$obj = \json_decode($input, false, 512, JSON_BIGINT_AS_STRING);
if ($errno = \json_last_error()) {
self::handleJsonError($errno);
} elseif ($obj === null && $input !== 'null') {
throw new DomainException('Null result with non-null input');
}
return $obj;
}
/**
* Encode a PHP array into a JSON string.
*
* @param array<mixed> $input A PHP array
*
* @return string JSON representation of the PHP array
*
* @throws DomainException Provided object could not be encoded to valid JSON
*/
public static function jsonEncode(array $input): string
{
$json = \json_encode($input, \JSON_UNESCAPED_SLASHES);
if ($errno = \json_last_error()) {
self::handleJsonError($errno);
} elseif ($json === 'null') {
throw new DomainException('Null result with non-null input');
}
if ($json === false) {
throw new DomainException('Provided object could not be encoded to valid JSON');
}
return $json;
}
/**
* Decode a string with URL-safe Base64.
*
* @param string $input A Base64 encoded string
*
* @return string A decoded string
*
* @throws InvalidArgumentException invalid base64 characters
*/
public static function urlsafeB64Decode(string $input): string
{
return \base64_decode(self::convertBase64UrlToBase64($input));
}
/**
* Convert a string in the base64url (URL-safe Base64) encoding to standard base64.
*
* @param string $input A Base64 encoded string with URL-safe characters (-_ and no padding)
*
* @return string A Base64 encoded string with standard characters (+/) and padding (=), when
* needed.
*
* @see https://www.rfc-editor.org/rfc/rfc4648
*/
public static function convertBase64UrlToBase64(string $input): string
{
$remainder = \strlen($input) % 4;
if ($remainder) {
$padlen = 4 - $remainder;
$input .= \str_repeat('=', $padlen);
}
return \strtr($input, '-_', '+/');
}
/**
* Encode a string with URL-safe Base64.
*
* @param string $input The string you want encoded
*
* @return string The base64 encode of what you passed in
*/
public static function urlsafeB64Encode(string $input): string
{
return \str_replace('=', '', \strtr(\base64_encode($input), '+/', '-_'));
}
/**
* Determine if an algorithm has been provided for each Key
*
* @param Key|ArrayAccess<string,Key>|array<string,Key> $keyOrKeyArray
* @param string|null $kid
*
* @throws UnexpectedValueException
*
* @return Key
*/
private static function getKey(
$keyOrKeyArray,
?string $kid
): Key {
if ($keyOrKeyArray instanceof Key) {
return $keyOrKeyArray;
}
if (empty($kid) && $kid !== '0') {
throw new UnexpectedValueException('"kid" empty, unable to lookup correct key');
}
if ($keyOrKeyArray instanceof CachedKeySet) {
// Skip "isset" check, as this will automatically refresh if not set
return $keyOrKeyArray[$kid];
}
if (!isset($keyOrKeyArray[$kid])) {
throw new UnexpectedValueException('"kid" invalid, unable to lookup correct key');
}
return $keyOrKeyArray[$kid];
}
/**
* @param string $left The string of known length to compare against
* @param string $right The user-supplied string
* @return bool
*/
public static function constantTimeEquals(string $left, string $right): bool
{
if (\function_exists('hash_equals')) {
return \hash_equals($left, $right);
}
$len = \min(self::safeStrlen($left), self::safeStrlen($right));
$status = 0;
for ($i = 0; $i < $len; $i++) {
$status |= (\ord($left[$i]) ^ \ord($right[$i]));
}
$status |= (self::safeStrlen($left) ^ self::safeStrlen($right));
return ($status === 0);
}
/**
* Helper method to create a JSON error.
*
* @param int $errno An error number from json_last_error()
*
* @throws DomainException
*
* @return void
*/
private static function handleJsonError(int $errno): void
{
$messages = [
JSON_ERROR_DEPTH => 'Maximum stack depth exceeded',
JSON_ERROR_STATE_MISMATCH => 'Invalid or malformed JSON',
JSON_ERROR_CTRL_CHAR => 'Unexpected control character found',
JSON_ERROR_SYNTAX => 'Syntax error, malformed JSON',
JSON_ERROR_UTF8 => 'Malformed UTF-8 characters' //PHP >= 5.3.3
];
throw new DomainException(
isset($messages[$errno])
? $messages[$errno]
: 'Unknown JSON error: ' . $errno
);
}
/**
* Get the number of bytes in cryptographic strings.
*
* @param string $str
*
* @return int
*/
private static function safeStrlen(string $str): int
{
if (\function_exists('mb_strlen')) {
return \mb_strlen($str, '8bit');
}
return \strlen($str);
}
/**
* Convert an ECDSA signature to an ASN.1 DER sequence
*
* @param string $sig The ECDSA signature to convert
* @return string The encoded DER object
*/
private static function signatureToDER(string $sig): string
{
// Separate the signature into r-value and s-value
$length = max(1, (int) (\strlen($sig) / 2));
list($r, $s) = \str_split($sig, $length);
// Trim leading zeros
$r = \ltrim($r, "\x00");
$s = \ltrim($s, "\x00");
// Convert r-value and s-value from unsigned big-endian integers to
// signed two's complement
if (\ord($r[0]) > 0x7f) {
$r = "\x00" . $r;
}
if (\ord($s[0]) > 0x7f) {
$s = "\x00" . $s;
}
return self::encodeDER(
self::ASN1_SEQUENCE,
self::encodeDER(self::ASN1_INTEGER, $r) .
self::encodeDER(self::ASN1_INTEGER, $s)
);
}
/**
* Encodes a value into a DER object.
*
* @param int $type DER tag
* @param string $value the value to encode
*
* @return string the encoded object
*/
private static function encodeDER(int $type, string $value): string
{
$tag_header = 0;
if ($type === self::ASN1_SEQUENCE) {
$tag_header |= 0x20;
}
// Type
$der = \chr($tag_header | $type);
// Length
$der .= \chr(\strlen($value));
return $der . $value;
}
/**
* Encodes signature from a DER object.
*
* @param string $der binary signature in DER format
* @param int $keySize the number of bits in the key
*
* @return string the signature
*/
private static function signatureFromDER(string $der, int $keySize): string
{
// OpenSSL returns the ECDSA signatures as a binary ASN.1 DER SEQUENCE
list($offset, $_) = self::readDER($der);
list($offset, $r) = self::readDER($der, $offset);
list($offset, $s) = self::readDER($der, $offset);
// Convert r-value and s-value from signed two's compliment to unsigned
// big-endian integers
$r = \ltrim($r, "\x00");
$s = \ltrim($s, "\x00");
// Pad out r and s so that they are $keySize bits long
$r = \str_pad($r, $keySize / 8, "\x00", STR_PAD_LEFT);
$s = \str_pad($s, $keySize / 8, "\x00", STR_PAD_LEFT);
return $r . $s;
}
/**
* Reads binary DER-encoded data and decodes into a single object
*
* @param string $der the binary data in DER format
* @param int $offset the offset of the data stream containing the object
* to decode
*
* @return array{int, string|null} the new offset and the decoded object
*/
private static function readDER(string $der, int $offset = 0): array
{
$pos = $offset;
$size = \strlen($der);
$constructed = (\ord($der[$pos]) >> 5) & 0x01;
$type = \ord($der[$pos++]) & 0x1f;
// Length
$len = \ord($der[$pos++]);
if ($len & 0x80) {
$n = $len & 0x1f;
$len = 0;
while ($n-- && $pos < $size) {
$len = ($len << 8) | \ord($der[$pos++]);
}
}
// Value
if ($type === self::ASN1_BIT_STRING) {
$pos++; // Skip the first contents octet (padding indicator)
$data = \substr($der, $pos, $len - 1);
$pos += $len - 1;
} elseif (!$constructed) {
$data = \substr($der, $pos, $len);
$pos += $len;
} else {
$data = null;
}
return [$pos, $data];
}
}

View File

@@ -1,20 +0,0 @@
<?php
namespace Firebase\JWT;
interface JWTExceptionWithPayloadInterface
{
/**
* Get the payload that caused this exception.
*
* @return object
*/
public function getPayload(): object;
/**
* Get the payload that caused this exception.
*
* @param object $payload
* @return void
*/
public function setPayload(object $payload): void;
}

View File

@@ -1,55 +0,0 @@
<?php
namespace Firebase\JWT;
use InvalidArgumentException;
use OpenSSLAsymmetricKey;
use OpenSSLCertificate;
use TypeError;
class Key
{
/**
* @param string|resource|OpenSSLAsymmetricKey|OpenSSLCertificate $keyMaterial
* @param string $algorithm
*/
public function __construct(
private $keyMaterial,
private string $algorithm
) {
if (
!\is_string($keyMaterial)
&& !$keyMaterial instanceof OpenSSLAsymmetricKey
&& !$keyMaterial instanceof OpenSSLCertificate
&& !\is_resource($keyMaterial)
) {
throw new TypeError('Key material must be a string, resource, or OpenSSLAsymmetricKey');
}
if (empty($keyMaterial)) {
throw new InvalidArgumentException('Key material must not be empty');
}
if (empty($algorithm)) {
throw new InvalidArgumentException('Algorithm must not be empty');
}
}
/**
* Return the algorithm valid for this key
*
* @return string
*/
public function getAlgorithm(): string
{
return $this->algorithm;
}
/**
* @return string|resource|OpenSSLAsymmetricKey|OpenSSLCertificate
*/
public function getKeyMaterial()
{
return $this->keyMaterial;
}
}

View File

@@ -1,7 +0,0 @@
<?php
namespace Firebase\JWT;
class SignatureInvalidException extends \UnexpectedValueException
{
}

View File

@@ -1,203 +0,0 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
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.

View File

@@ -1,19 +0,0 @@
Google PHP API Client Services
==============================
[Reference Documentation](https://googleapis.github.io/google-api-php-client-services)
**NOTE**: please check to see if the package you'd like to install is available in our
list of [Google cloud packages](https://cloud.google.com/php/docs/reference) first, as
these are the recommended libraries.
## Requirements
[Google API PHP Client](https://github.com/googleapis/google-api-php-client/releases)
## Usage
This library is automatically updated daily with new API changes, and tagged weekly.
It is installed as part of the
[Google API PHP Client](https://github.com/googleapis/google-api-php-client/releases)
library via Composer, which will pull down the most recent tag.

View File

@@ -1,7 +0,0 @@
# Security Policy
To report a security issue, please use [g.co/vulnz](https://g.co/vulnz).
The Google Security Team will respond within 5 working days of your report on g.co/vulnz.
We use g.co/vulnz for our intake, and do coordination and disclosure here using GitHub Security Advisory to privately discuss and fix the issue.

View File

@@ -1,36 +0,0 @@
<?php
// For older (pre-2.7.2) verions of google/apiclient
if (
file_exists(__DIR__ . '/../apiclient/src/Google/Client.php')
&& !class_exists('Google_Client', false)
) {
require_once(__DIR__ . '/../apiclient/src/Google/Client.php');
if (
defined('Google_Client::LIBVER')
&& version_compare(Google_Client::LIBVER, '2.7.2', '<=')
) {
$servicesClassMap = [
'Google\\Client' => 'Google_Client',
'Google\\Service' => 'Google_Service',
'Google\\Service\\Resource' => 'Google_Service_Resource',
'Google\\Model' => 'Google_Model',
'Google\\Collection' => 'Google_Collection',
];
foreach ($servicesClassMap as $alias => $class) {
class_alias($class, $alias);
}
}
}
spl_autoload_register(function ($class) {
if (0 === strpos($class, 'Google_Service_')) {
// Autoload the new class, which will also create an alias for the
// old class by changing underscores to namespaces:
// Google_Service_Speech_Resource_Operations
// => Google\Service\Speech\Resource\Operations
$classExists = class_exists($newClass = str_replace('_', '\\', $class));
if ($classExists) {
return true;
}
}
}, true, true);

View File

@@ -1,27 +0,0 @@
{
"name": "google/apiclient-services",
"type": "library",
"description": "Client library for Google APIs",
"keywords": ["google"],
"homepage": "http://developers.google.com/api-client-library/php",
"license": "Apache-2.0",
"require": {
"php": "^8.1"
},
"require-dev": {
"phpunit/phpunit": "^9.6"
},
"autoload": {
"psr-4": {
"Google\\Service\\": "src"
},
"files": [
"autoload.php"
]
},
"autoload-dev": {
"psr-4": {
"Google\\": "tests/mocks"
}
}
}

View File

@@ -1,94 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service;
use Google\Client;
/**
* Service definition for ACMEDNS (v1).
*
* <p>
* Google Domains ACME DNS API that allows users to complete ACME DNS-01
* challenges for a domain.</p>
*
* <p>
* For more information about this service, see the API
* <a href="https://developers.google.com/domains/acme-dns/" target="_blank">Documentation</a>
* </p>
*
* @author Google, Inc.
*/
class ACMEDNS extends \Google\Service
{
public $acmeChallengeSets;
public $rootUrlTemplate;
/**
* Constructs the internal representation of the ACMEDNS service.
*
* @param Client|array $clientOrConfig The client used to deliver requests, or a
* config array to pass to a new Client instance.
* @param string $rootUrl The root URL used for requests to the service.
*/
public function __construct($clientOrConfig = [], $rootUrl = null)
{
parent::__construct($clientOrConfig);
$this->rootUrl = $rootUrl ?: 'https://acmedns.googleapis.com/';
$this->rootUrlTemplate = $rootUrl ?: 'https://acmedns.UNIVERSE_DOMAIN/';
$this->servicePath = '';
$this->batchPath = 'batch';
$this->version = 'v1';
$this->serviceName = 'acmedns';
$this->acmeChallengeSets = new ACMEDNS\Resource\AcmeChallengeSets(
$this,
$this->serviceName,
'acmeChallengeSets',
[
'methods' => [
'get' => [
'path' => 'v1/acmeChallengeSets/{rootDomain}',
'httpMethod' => 'GET',
'parameters' => [
'rootDomain' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'rotateChallenges' => [
'path' => 'v1/acmeChallengeSets/{rootDomain}:rotateChallenges',
'httpMethod' => 'POST',
'parameters' => [
'rootDomain' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],
]
]
);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ACMEDNS::class, 'Google_Service_ACMEDNS');

View File

@@ -1,43 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\ACMEDNS;
class AcmeChallengeSet extends \Google\Collection
{
protected $collection_key = 'record';
protected $recordType = AcmeTxtRecord::class;
protected $recordDataType = 'array';
/**
* @param AcmeTxtRecord[]
*/
public function setRecord($record)
{
$this->record = $record;
}
/**
* @return AcmeTxtRecord[]
*/
public function getRecord()
{
return $this->record;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AcmeChallengeSet::class, 'Google_Service_ACMEDNS_AcmeChallengeSet');

View File

@@ -1,80 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\ACMEDNS;
class AcmeTxtRecord extends \Google\Model
{
/**
* @var string
*/
public $digest;
/**
* @var string
*/
public $fqdn;
/**
* @var string
*/
public $updateTime;
/**
* @param string
*/
public function setDigest($digest)
{
$this->digest = $digest;
}
/**
* @return string
*/
public function getDigest()
{
return $this->digest;
}
/**
* @param string
*/
public function setFqdn($fqdn)
{
$this->fqdn = $fqdn;
}
/**
* @return string
*/
public function getFqdn()
{
return $this->fqdn;
}
/**
* @param string
*/
public function setUpdateTime($updateTime)
{
$this->updateTime = $updateTime;
}
/**
* @return string
*/
public function getUpdateTime()
{
return $this->updateTime;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AcmeTxtRecord::class, 'Google_Service_ACMEDNS_AcmeTxtRecord');

View File

@@ -1,74 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\ACMEDNS\Resource;
use Google\Service\ACMEDNS\AcmeChallengeSet;
use Google\Service\ACMEDNS\RotateChallengesRequest;
/**
* The "acmeChallengeSets" collection of methods.
* Typical usage is:
* <code>
* $acmednsService = new Google\Service\ACMEDNS(...);
* $acmeChallengeSets = $acmednsService->acmeChallengeSets;
* </code>
*/
class AcmeChallengeSets extends \Google\Service\Resource
{
/**
* Gets the ACME challenge set for a given domain name. Domain names must be
* provided in Punycode. (acmeChallengeSets.get)
*
* @param string $rootDomain Required. SLD + TLD domain name to list challenges.
* For example, this would be "google.com" for any FQDN under "google.com". That
* includes challenges for "subdomain.google.com". This MAY be Unicode or
* Punycode.
* @param array $optParams Optional parameters.
* @return AcmeChallengeSet
* @throws \Google\Service\Exception
*/
public function get($rootDomain, $optParams = [])
{
$params = ['rootDomain' => $rootDomain];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], AcmeChallengeSet::class);
}
/**
* Rotate the ACME challenges for a given domain name. By default, removes any
* challenges that are older than 30 days. Domain names must be provided in
* Punycode. (acmeChallengeSets.rotateChallenges)
*
* @param string $rootDomain Required. SLD + TLD domain name to update records
* for. For example, this would be "google.com" for any FQDN under "google.com".
* That includes challenges for "subdomain.google.com". This MAY be Unicode or
* Punycode.
* @param RotateChallengesRequest $postBody
* @param array $optParams Optional parameters.
* @return AcmeChallengeSet
* @throws \Google\Service\Exception
*/
public function rotateChallenges($rootDomain, RotateChallengesRequest $postBody, $optParams = [])
{
$params = ['rootDomain' => $rootDomain, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('rotateChallenges', [$params], AcmeChallengeSet::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AcmeChallengeSets::class, 'Google_Service_ACMEDNS_Resource_AcmeChallengeSets');

View File

@@ -1,95 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\ACMEDNS;
class RotateChallengesRequest extends \Google\Collection
{
protected $collection_key = 'recordsToRemove';
/**
* @var string
*/
public $accessToken;
/**
* @var bool
*/
public $keepExpiredRecords;
protected $recordsToAddType = AcmeTxtRecord::class;
protected $recordsToAddDataType = 'array';
protected $recordsToRemoveType = AcmeTxtRecord::class;
protected $recordsToRemoveDataType = 'array';
/**
* @param string
*/
public function setAccessToken($accessToken)
{
$this->accessToken = $accessToken;
}
/**
* @return string
*/
public function getAccessToken()
{
return $this->accessToken;
}
/**
* @param bool
*/
public function setKeepExpiredRecords($keepExpiredRecords)
{
$this->keepExpiredRecords = $keepExpiredRecords;
}
/**
* @return bool
*/
public function getKeepExpiredRecords()
{
return $this->keepExpiredRecords;
}
/**
* @param AcmeTxtRecord[]
*/
public function setRecordsToAdd($recordsToAdd)
{
$this->recordsToAdd = $recordsToAdd;
}
/**
* @return AcmeTxtRecord[]
*/
public function getRecordsToAdd()
{
return $this->recordsToAdd;
}
/**
* @param AcmeTxtRecord[]
*/
public function setRecordsToRemove($recordsToRemove)
{
$this->recordsToRemove = $recordsToRemove;
}
/**
* @return AcmeTxtRecord[]
*/
public function getRecordsToRemove()
{
return $this->recordsToRemove;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(RotateChallengesRequest::class, 'Google_Service_ACMEDNS_RotateChallengesRequest');

View File

@@ -1,450 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service;
use Google\Client;
/**
* Service definition for AIPlatformNotebooks (v2).
*
* <p>
* Notebooks API is used to manage notebook resources in Google Cloud.</p>
*
* <p>
* For more information about this service, see the API
* <a href="https://cloud.google.com/notebooks/docs/" target="_blank">Documentation</a>
* </p>
*
* @author Google, Inc.
*/
class AIPlatformNotebooks extends \Google\Service
{
/** See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.. */
const CLOUD_PLATFORM =
"https://www.googleapis.com/auth/cloud-platform";
public $projects_locations;
public $projects_locations_instances;
public $projects_locations_operations;
public $rootUrlTemplate;
/**
* Constructs the internal representation of the AIPlatformNotebooks service.
*
* @param Client|array $clientOrConfig The client used to deliver requests, or a
* config array to pass to a new Client instance.
* @param string $rootUrl The root URL used for requests to the service.
*/
public function __construct($clientOrConfig = [], $rootUrl = null)
{
parent::__construct($clientOrConfig);
$this->rootUrl = $rootUrl ?: 'https://notebooks.googleapis.com/';
$this->rootUrlTemplate = $rootUrl ?: 'https://notebooks.UNIVERSE_DOMAIN/';
$this->servicePath = '';
$this->batchPath = 'batch';
$this->version = 'v2';
$this->serviceName = 'notebooks';
$this->projects_locations = new AIPlatformNotebooks\Resource\ProjectsLocations(
$this,
$this->serviceName,
'locations',
[
'methods' => [
'get' => [
'path' => 'v2/{+name}',
'httpMethod' => 'GET',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'list' => [
'path' => 'v2/{+name}/locations',
'httpMethod' => 'GET',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
'extraLocationTypes' => [
'location' => 'query',
'type' => 'string',
'repeated' => true,
],
'filter' => [
'location' => 'query',
'type' => 'string',
],
'pageSize' => [
'location' => 'query',
'type' => 'integer',
],
'pageToken' => [
'location' => 'query',
'type' => 'string',
],
],
],
]
]
);
$this->projects_locations_instances = new AIPlatformNotebooks\Resource\ProjectsLocationsInstances(
$this,
$this->serviceName,
'instances',
[
'methods' => [
'checkAuthorization' => [
'path' => 'v2/{+name}:checkAuthorization',
'httpMethod' => 'POST',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'checkUpgradability' => [
'path' => 'v2/{+notebookInstance}:checkUpgradability',
'httpMethod' => 'GET',
'parameters' => [
'notebookInstance' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'create' => [
'path' => 'v2/{+parent}/instances',
'httpMethod' => 'POST',
'parameters' => [
'parent' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
'instanceId' => [
'location' => 'query',
'type' => 'string',
],
'requestId' => [
'location' => 'query',
'type' => 'string',
],
],
],'delete' => [
'path' => 'v2/{+name}',
'httpMethod' => 'DELETE',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
'requestId' => [
'location' => 'query',
'type' => 'string',
],
],
],'diagnose' => [
'path' => 'v2/{+name}:diagnose',
'httpMethod' => 'POST',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'generateAccessToken' => [
'path' => 'v2/{+name}:generateAccessToken',
'httpMethod' => 'POST',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'get' => [
'path' => 'v2/{+name}',
'httpMethod' => 'GET',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'getConfig' => [
'path' => 'v2/{+name}/instances:getConfig',
'httpMethod' => 'GET',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'getIamPolicy' => [
'path' => 'v2/{+resource}:getIamPolicy',
'httpMethod' => 'GET',
'parameters' => [
'resource' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
'options.requestedPolicyVersion' => [
'location' => 'query',
'type' => 'integer',
],
],
],'list' => [
'path' => 'v2/{+parent}/instances',
'httpMethod' => 'GET',
'parameters' => [
'parent' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
'filter' => [
'location' => 'query',
'type' => 'string',
],
'orderBy' => [
'location' => 'query',
'type' => 'string',
],
'pageSize' => [
'location' => 'query',
'type' => 'integer',
],
'pageToken' => [
'location' => 'query',
'type' => 'string',
],
],
],'patch' => [
'path' => 'v2/{+name}',
'httpMethod' => 'PATCH',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
'requestId' => [
'location' => 'query',
'type' => 'string',
],
'updateMask' => [
'location' => 'query',
'type' => 'string',
],
],
],'reportInfoSystem' => [
'path' => 'v2/{+name}:reportInfoSystem',
'httpMethod' => 'POST',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'reset' => [
'path' => 'v2/{+name}:reset',
'httpMethod' => 'POST',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'resizeDisk' => [
'path' => 'v2/{+notebookInstance}:resizeDisk',
'httpMethod' => 'POST',
'parameters' => [
'notebookInstance' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'restore' => [
'path' => 'v2/{+name}:restore',
'httpMethod' => 'POST',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'rollback' => [
'path' => 'v2/{+name}:rollback',
'httpMethod' => 'POST',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'setIamPolicy' => [
'path' => 'v2/{+resource}:setIamPolicy',
'httpMethod' => 'POST',
'parameters' => [
'resource' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'start' => [
'path' => 'v2/{+name}:start',
'httpMethod' => 'POST',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'stop' => [
'path' => 'v2/{+name}:stop',
'httpMethod' => 'POST',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'testIamPermissions' => [
'path' => 'v2/{+resource}:testIamPermissions',
'httpMethod' => 'POST',
'parameters' => [
'resource' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'upgrade' => [
'path' => 'v2/{+name}:upgrade',
'httpMethod' => 'POST',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'upgradeSystem' => [
'path' => 'v2/{+name}:upgradeSystem',
'httpMethod' => 'POST',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],
]
]
);
$this->projects_locations_operations = new AIPlatformNotebooks\Resource\ProjectsLocationsOperations(
$this,
$this->serviceName,
'operations',
[
'methods' => [
'cancel' => [
'path' => 'v2/{+name}:cancel',
'httpMethod' => 'POST',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'delete' => [
'path' => 'v2/{+name}',
'httpMethod' => 'DELETE',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'get' => [
'path' => 'v2/{+name}',
'httpMethod' => 'GET',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'list' => [
'path' => 'v2/{+name}/operations',
'httpMethod' => 'GET',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
'filter' => [
'location' => 'query',
'type' => 'string',
],
'pageSize' => [
'location' => 'query',
'type' => 'integer',
],
'pageToken' => [
'location' => 'query',
'type' => 'string',
],
'returnPartialSuccess' => [
'location' => 'query',
'type' => 'boolean',
],
],
],
]
]
);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AIPlatformNotebooks::class, 'Google_Service_AIPlatformNotebooks');

View File

@@ -1,136 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class AcceleratorConfig extends \Google\Model
{
/**
* Accelerator type is not specified.
*/
public const TYPE_ACCELERATOR_TYPE_UNSPECIFIED = 'ACCELERATOR_TYPE_UNSPECIFIED';
/**
* Accelerator type is Nvidia Tesla P100.
*/
public const TYPE_NVIDIA_TESLA_P100 = 'NVIDIA_TESLA_P100';
/**
* Accelerator type is Nvidia Tesla V100.
*/
public const TYPE_NVIDIA_TESLA_V100 = 'NVIDIA_TESLA_V100';
/**
* Accelerator type is Nvidia Tesla P4.
*/
public const TYPE_NVIDIA_TESLA_P4 = 'NVIDIA_TESLA_P4';
/**
* Accelerator type is Nvidia Tesla T4.
*/
public const TYPE_NVIDIA_TESLA_T4 = 'NVIDIA_TESLA_T4';
/**
* Accelerator type is Nvidia Tesla A100 - 40GB.
*/
public const TYPE_NVIDIA_TESLA_A100 = 'NVIDIA_TESLA_A100';
/**
* Accelerator type is Nvidia Tesla A100 - 80GB.
*/
public const TYPE_NVIDIA_A100_80GB = 'NVIDIA_A100_80GB';
/**
* Accelerator type is Nvidia Tesla L4.
*/
public const TYPE_NVIDIA_L4 = 'NVIDIA_L4';
/**
* Accelerator type is Nvidia Tesla H100 - 80GB.
*/
public const TYPE_NVIDIA_H100_80GB = 'NVIDIA_H100_80GB';
/**
* Accelerator type is Nvidia Tesla H100 - MEGA 80GB.
*/
public const TYPE_NVIDIA_H100_MEGA_80GB = 'NVIDIA_H100_MEGA_80GB';
/**
* Accelerator type is Nvidia Tesla H200 - 141GB.
*/
public const TYPE_NVIDIA_H200_141GB = 'NVIDIA_H200_141GB';
/**
* Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
*/
public const TYPE_NVIDIA_TESLA_T4_VWS = 'NVIDIA_TESLA_T4_VWS';
/**
* Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
*/
public const TYPE_NVIDIA_TESLA_P100_VWS = 'NVIDIA_TESLA_P100_VWS';
/**
* Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
*/
public const TYPE_NVIDIA_TESLA_P4_VWS = 'NVIDIA_TESLA_P4_VWS';
/**
* Accelerator type is NVIDIA B200.
*/
public const TYPE_NVIDIA_B200 = 'NVIDIA_B200';
/**
* Optional. Count of cores of this accelerator.
*
* @var string
*/
public $coreCount;
/**
* Optional. Type of this accelerator.
*
* @var string
*/
public $type;
/**
* Optional. Count of cores of this accelerator.
*
* @param string $coreCount
*/
public function setCoreCount($coreCount)
{
$this->coreCount = $coreCount;
}
/**
* @return string
*/
public function getCoreCount()
{
return $this->coreCount;
}
/**
* Optional. Type of this accelerator.
*
* Accepted values: ACCELERATOR_TYPE_UNSPECIFIED, NVIDIA_TESLA_P100,
* NVIDIA_TESLA_V100, NVIDIA_TESLA_P4, NVIDIA_TESLA_T4, NVIDIA_TESLA_A100,
* NVIDIA_A100_80GB, NVIDIA_L4, NVIDIA_H100_80GB, NVIDIA_H100_MEGA_80GB,
* NVIDIA_H200_141GB, NVIDIA_TESLA_T4_VWS, NVIDIA_TESLA_P100_VWS,
* NVIDIA_TESLA_P4_VWS, NVIDIA_B200
*
* @param self::TYPE_* $type
*/
public function setType($type)
{
$this->type = $type;
}
/**
* @return self::TYPE_*
*/
public function getType()
{
return $this->type;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AcceleratorConfig::class, 'Google_Service_AIPlatformNotebooks_AcceleratorConfig');

View File

@@ -1,56 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class AccessConfig extends \Google\Model
{
/**
* An external IP address associated with this instance. Specify an unused
* static external IP address available to the project or leave this field
* undefined to use an IP from a shared ephemeral IP address pool. If you
* specify a static external IP address, it must live in the same region as
* the zone of the instance.
*
* @var string
*/
public $externalIp;
/**
* An external IP address associated with this instance. Specify an unused
* static external IP address available to the project or leave this field
* undefined to use an IP from a shared ephemeral IP address pool. If you
* specify a static external IP address, it must live in the same region as
* the zone of the instance.
*
* @param string $externalIp
*/
public function setExternalIp($externalIp)
{
$this->externalIp = $externalIp;
}
/**
* @return string
*/
public function getExternalIp()
{
return $this->externalIp;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AccessConfig::class, 'Google_Service_AIPlatformNotebooks_AccessConfig');

View File

@@ -1,216 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class Binding extends \Google\Collection
{
protected $collection_key = 'members';
protected $conditionType = Expr::class;
protected $conditionDataType = '';
/**
* Specifies the principals requesting access for a Google Cloud resource.
* `members` can have the following values: * `allUsers`: A special identifier
* that represents anyone who is on the internet; with or without a Google
* account. * `allAuthenticatedUsers`: A special identifier that represents
* anyone who is authenticated with a Google account or a service account.
* Does not include identities that come from external identity providers
* (IdPs) through identity federation. * `user:{emailid}`: An email address
* that represents a specific Google account. For example, `alice@example.com`
* . * `serviceAccount:{emailid}`: An email address that represents a Google
* service account. For example, `my-other-app@appspot.gserviceaccount.com`. *
* `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
* identifier for a [Kubernetes service
* account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-
* service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-
* kubernetes-sa]`. * `group:{emailid}`: An email address that represents a
* Google group. For example, `admins@example.com`. * `domain:{domain}`: The G
* Suite domain (primary) that represents all the users of that domain. For
* example, `google.com` or `example.com`. * `principal://iam.googleapis.com/l
* ocations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`
* : A single identity in a workforce identity pool. * `principalSet://iam.goo
* gleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
* All workforce identities in a group. * `principalSet://iam.googleapis.com/l
* ocations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attrib
* ute_value}`: All workforce identities with a specific attribute value. * `p
* rincipalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}`
* : All identities in a workforce identity pool. * `principal://iam.googleapi
* s.com/projects/{project_number}/locations/global/workloadIdentityPools/{poo
* l_id}/subject/{subject_attribute_value}`: A single identity in a workload
* identity pool. * `principalSet://iam.googleapis.com/projects/{project_numbe
* r}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A
* workload identity pool group. * `principalSet://iam.googleapis.com/projects
* /{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribut
* e.{attribute_name}/{attribute_value}`: All identities in a workload
* identity pool with a certain attribute. * `principalSet://iam.googleapis.co
* m/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id
* }`: All identities in a workload identity pool. *
* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
* identifier) representing a user that has been recently deleted. For
* example, `alice@example.com?uid=123456789012345678901`. If the user is
* recovered, this value reverts to `user:{emailid}` and the recovered user
* retains the role in the binding. *
* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
* unique identifier) representing a service account that has been recently
* deleted. For example, `my-other-
* app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service
* account is undeleted, this value reverts to `serviceAccount:{emailid}` and
* the undeleted service account retains the role in the binding. *
* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
* identifier) representing a Google group that has been recently deleted. For
* example, `admins@example.com?uid=123456789012345678901`. If the group is
* recovered, this value reverts to `group:{emailid}` and the recovered group
* retains the role in the binding. * `deleted:principal://iam.googleapis.com/
* locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}
* `: Deleted single identity in a workforce identity pool. For example,
* `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-
* pool-id/subject/my-subject-attribute-value`.
*
* @var string[]
*/
public $members;
/**
* Role that is assigned to the list of `members`, or principals. For example,
* `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the
* IAM roles and permissions, see the [IAM
* documentation](https://cloud.google.com/iam/docs/roles-overview). For a
* list of the available pre-defined roles, see
* [here](https://cloud.google.com/iam/docs/understanding-roles).
*
* @var string
*/
public $role;
/**
* The condition that is associated with this binding. If the condition
* evaluates to `true`, then this binding applies to the current request. If
* the condition evaluates to `false`, then this binding does not apply to the
* current request. However, a different role binding might grant the same
* role to one or more of the principals in this binding. To learn which
* resources support conditions in their IAM policies, see the [IAM
* documentation](https://cloud.google.com/iam/help/conditions/resource-
* policies).
*
* @param Expr $condition
*/
public function setCondition(Expr $condition)
{
$this->condition = $condition;
}
/**
* @return Expr
*/
public function getCondition()
{
return $this->condition;
}
/**
* Specifies the principals requesting access for a Google Cloud resource.
* `members` can have the following values: * `allUsers`: A special identifier
* that represents anyone who is on the internet; with or without a Google
* account. * `allAuthenticatedUsers`: A special identifier that represents
* anyone who is authenticated with a Google account or a service account.
* Does not include identities that come from external identity providers
* (IdPs) through identity federation. * `user:{emailid}`: An email address
* that represents a specific Google account. For example, `alice@example.com`
* . * `serviceAccount:{emailid}`: An email address that represents a Google
* service account. For example, `my-other-app@appspot.gserviceaccount.com`. *
* `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
* identifier for a [Kubernetes service
* account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-
* service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-
* kubernetes-sa]`. * `group:{emailid}`: An email address that represents a
* Google group. For example, `admins@example.com`. * `domain:{domain}`: The G
* Suite domain (primary) that represents all the users of that domain. For
* example, `google.com` or `example.com`. * `principal://iam.googleapis.com/l
* ocations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`
* : A single identity in a workforce identity pool. * `principalSet://iam.goo
* gleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
* All workforce identities in a group. * `principalSet://iam.googleapis.com/l
* ocations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attrib
* ute_value}`: All workforce identities with a specific attribute value. * `p
* rincipalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}`
* : All identities in a workforce identity pool. * `principal://iam.googleapi
* s.com/projects/{project_number}/locations/global/workloadIdentityPools/{poo
* l_id}/subject/{subject_attribute_value}`: A single identity in a workload
* identity pool. * `principalSet://iam.googleapis.com/projects/{project_numbe
* r}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A
* workload identity pool group. * `principalSet://iam.googleapis.com/projects
* /{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribut
* e.{attribute_name}/{attribute_value}`: All identities in a workload
* identity pool with a certain attribute. * `principalSet://iam.googleapis.co
* m/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id
* }`: All identities in a workload identity pool. *
* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
* identifier) representing a user that has been recently deleted. For
* example, `alice@example.com?uid=123456789012345678901`. If the user is
* recovered, this value reverts to `user:{emailid}` and the recovered user
* retains the role in the binding. *
* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
* unique identifier) representing a service account that has been recently
* deleted. For example, `my-other-
* app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service
* account is undeleted, this value reverts to `serviceAccount:{emailid}` and
* the undeleted service account retains the role in the binding. *
* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
* identifier) representing a Google group that has been recently deleted. For
* example, `admins@example.com?uid=123456789012345678901`. If the group is
* recovered, this value reverts to `group:{emailid}` and the recovered group
* retains the role in the binding. * `deleted:principal://iam.googleapis.com/
* locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}
* `: Deleted single identity in a workforce identity pool. For example,
* `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-
* pool-id/subject/my-subject-attribute-value`.
*
* @param string[] $members
*/
public function setMembers($members)
{
$this->members = $members;
}
/**
* @return string[]
*/
public function getMembers()
{
return $this->members;
}
/**
* Role that is assigned to the list of `members`, or principals. For example,
* `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the
* IAM roles and permissions, see the [IAM
* documentation](https://cloud.google.com/iam/docs/roles-overview). For a
* list of the available pre-defined roles, see
* [here](https://cloud.google.com/iam/docs/understanding-roles).
*
* @param string $role
*/
public function setRole($role)
{
$this->role = $role;
}
/**
* @return string
*/
public function getRole()
{
return $this->role;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Binding::class, 'Google_Service_AIPlatformNotebooks_Binding');

View File

@@ -1,167 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class BootDisk extends \Google\Model
{
/**
* Disk encryption is not specified.
*/
public const DISK_ENCRYPTION_DISK_ENCRYPTION_UNSPECIFIED = 'DISK_ENCRYPTION_UNSPECIFIED';
/**
* Use Google managed encryption keys to encrypt the boot disk.
*/
public const DISK_ENCRYPTION_GMEK = 'GMEK';
/**
* Use customer managed encryption keys to encrypt the boot disk.
*/
public const DISK_ENCRYPTION_CMEK = 'CMEK';
/**
* Disk type not set.
*/
public const DISK_TYPE_DISK_TYPE_UNSPECIFIED = 'DISK_TYPE_UNSPECIFIED';
/**
* Standard persistent disk type.
*/
public const DISK_TYPE_PD_STANDARD = 'PD_STANDARD';
/**
* SSD persistent disk type.
*/
public const DISK_TYPE_PD_SSD = 'PD_SSD';
/**
* Balanced persistent disk type.
*/
public const DISK_TYPE_PD_BALANCED = 'PD_BALANCED';
/**
* Extreme persistent disk type.
*/
public const DISK_TYPE_PD_EXTREME = 'PD_EXTREME';
/**
* Hyperdisk Balanced persistent disk type.
*/
public const DISK_TYPE_HYPERDISK_BALANCED = 'HYPERDISK_BALANCED';
/**
* Optional. Input only. Disk encryption method used on the boot and data
* disks, defaults to GMEK.
*
* @var string
*/
public $diskEncryption;
/**
* Optional. The size of the boot disk in GB attached to this instance, up to
* a maximum of 64000 GB (64 TB). If not specified, this defaults to the
* recommended value of 150GB.
*
* @var string
*/
public $diskSizeGb;
/**
* Optional. Indicates the type of the disk.
*
* @var string
*/
public $diskType;
/**
* Optional. Input only. The KMS key used to encrypt the disks, only
* applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locat
* ions/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more
* about using your own encryption keys.
*
* @var string
*/
public $kmsKey;
/**
* Optional. Input only. Disk encryption method used on the boot and data
* disks, defaults to GMEK.
*
* Accepted values: DISK_ENCRYPTION_UNSPECIFIED, GMEK, CMEK
*
* @param self::DISK_ENCRYPTION_* $diskEncryption
*/
public function setDiskEncryption($diskEncryption)
{
$this->diskEncryption = $diskEncryption;
}
/**
* @return self::DISK_ENCRYPTION_*
*/
public function getDiskEncryption()
{
return $this->diskEncryption;
}
/**
* Optional. The size of the boot disk in GB attached to this instance, up to
* a maximum of 64000 GB (64 TB). If not specified, this defaults to the
* recommended value of 150GB.
*
* @param string $diskSizeGb
*/
public function setDiskSizeGb($diskSizeGb)
{
$this->diskSizeGb = $diskSizeGb;
}
/**
* @return string
*/
public function getDiskSizeGb()
{
return $this->diskSizeGb;
}
/**
* Optional. Indicates the type of the disk.
*
* Accepted values: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED,
* PD_EXTREME, HYPERDISK_BALANCED
*
* @param self::DISK_TYPE_* $diskType
*/
public function setDiskType($diskType)
{
$this->diskType = $diskType;
}
/**
* @return self::DISK_TYPE_*
*/
public function getDiskType()
{
return $this->diskType;
}
/**
* Optional. Input only. The KMS key used to encrypt the disks, only
* applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locat
* ions/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more
* about using your own encryption keys.
*
* @param string $kmsKey
*/
public function setKmsKey($kmsKey)
{
$this->kmsKey = $kmsKey;
}
/**
* @return string
*/
public function getKmsKey()
{
return $this->kmsKey;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BootDisk::class, 'Google_Service_AIPlatformNotebooks_BootDisk');

View File

@@ -1,25 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class BootImage extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BootImage::class, 'Google_Service_AIPlatformNotebooks_BootImage');

View File

@@ -1,25 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class CancelOperationRequest extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CancelOperationRequest::class, 'Google_Service_AIPlatformNotebooks_CancelOperationRequest');

View File

@@ -1,50 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class CheckAuthorizationRequest extends \Google\Model
{
/**
* Optional. The details of the OAuth authorization response. This may include
* additional params such as dry_run, version_info, origin, propagate, etc.
*
* @var string[]
*/
public $authorizationDetails;
/**
* Optional. The details of the OAuth authorization response. This may include
* additional params such as dry_run, version_info, origin, propagate, etc.
*
* @param string[] $authorizationDetails
*/
public function setAuthorizationDetails($authorizationDetails)
{
$this->authorizationDetails = $authorizationDetails;
}
/**
* @return string[]
*/
public function getAuthorizationDetails()
{
return $this->authorizationDetails;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CheckAuthorizationRequest::class, 'Google_Service_AIPlatformNotebooks_CheckAuthorizationRequest');

View File

@@ -1,99 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class CheckAuthorizationResponse extends \Google\Model
{
protected $internal_gapi_mappings = [
"oauthUri" => "oauth_uri",
];
/**
* Output only. Timestamp when this Authorization request was created.
*
* @var string
*/
public $createTime;
/**
* If the user has not completed OAuth consent, then the oauth_url is
* returned. Otherwise, this field is not set.
*
* @var string
*/
public $oauthUri;
/**
* Success indicates that the user completed OAuth consent and access tokens
* can be generated.
*
* @var bool
*/
public $success;
/**
* Output only. Timestamp when this Authorization request was created.
*
* @param string $createTime
*/
public function setCreateTime($createTime)
{
$this->createTime = $createTime;
}
/**
* @return string
*/
public function getCreateTime()
{
return $this->createTime;
}
/**
* If the user has not completed OAuth consent, then the oauth_url is
* returned. Otherwise, this field is not set.
*
* @param string $oauthUri
*/
public function setOauthUri($oauthUri)
{
$this->oauthUri = $oauthUri;
}
/**
* @return string
*/
public function getOauthUri()
{
return $this->oauthUri;
}
/**
* Success indicates that the user completed OAuth consent and access tokens
* can be generated.
*
* @param bool $success
*/
public function setSuccess($success)
{
$this->success = $success;
}
/**
* @return bool
*/
public function getSuccess()
{
return $this->success;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CheckAuthorizationResponse::class, 'Google_Service_AIPlatformNotebooks_CheckAuthorizationResponse');

View File

@@ -1,120 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class CheckInstanceUpgradabilityResponse extends \Google\Model
{
/**
* The new image self link this instance will be upgraded to if calling the
* upgrade endpoint. This field will only be populated if field upgradeable is
* true.
*
* @var string
*/
public $upgradeImage;
/**
* Additional information about upgrade.
*
* @var string
*/
public $upgradeInfo;
/**
* The version this instance will be upgraded to if calling the upgrade
* endpoint. This field will only be populated if field upgradeable is true.
*
* @var string
*/
public $upgradeVersion;
/**
* If an instance is upgradeable.
*
* @var bool
*/
public $upgradeable;
/**
* The new image self link this instance will be upgraded to if calling the
* upgrade endpoint. This field will only be populated if field upgradeable is
* true.
*
* @param string $upgradeImage
*/
public function setUpgradeImage($upgradeImage)
{
$this->upgradeImage = $upgradeImage;
}
/**
* @return string
*/
public function getUpgradeImage()
{
return $this->upgradeImage;
}
/**
* Additional information about upgrade.
*
* @param string $upgradeInfo
*/
public function setUpgradeInfo($upgradeInfo)
{
$this->upgradeInfo = $upgradeInfo;
}
/**
* @return string
*/
public function getUpgradeInfo()
{
return $this->upgradeInfo;
}
/**
* The version this instance will be upgraded to if calling the upgrade
* endpoint. This field will only be populated if field upgradeable is true.
*
* @param string $upgradeVersion
*/
public function setUpgradeVersion($upgradeVersion)
{
$this->upgradeVersion = $upgradeVersion;
}
/**
* @return string
*/
public function getUpgradeVersion()
{
return $this->upgradeVersion;
}
/**
* If an instance is upgradeable.
*
* @param bool $upgradeable
*/
public function setUpgradeable($upgradeable)
{
$this->upgradeable = $upgradeable;
}
/**
* @return bool
*/
public function getUpgradeable()
{
return $this->upgradeable;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CheckInstanceUpgradabilityResponse::class, 'Google_Service_AIPlatformNotebooks_CheckInstanceUpgradabilityResponse');

View File

@@ -1,58 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class ConfidentialInstanceConfig extends \Google\Model
{
/**
* No type specified. Do not use this value.
*/
public const CONFIDENTIAL_INSTANCE_TYPE_CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED = 'CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED';
/**
* AMD Secure Encrypted Virtualization.
*/
public const CONFIDENTIAL_INSTANCE_TYPE_SEV = 'SEV';
/**
* Optional. Defines the type of technology used by the confidential instance.
*
* @var string
*/
public $confidentialInstanceType;
/**
* Optional. Defines the type of technology used by the confidential instance.
*
* Accepted values: CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED, SEV
*
* @param self::CONFIDENTIAL_INSTANCE_TYPE_* $confidentialInstanceType
*/
public function setConfidentialInstanceType($confidentialInstanceType)
{
$this->confidentialInstanceType = $confidentialInstanceType;
}
/**
* @return self::CONFIDENTIAL_INSTANCE_TYPE_*
*/
public function getConfidentialInstanceType()
{
return $this->confidentialInstanceType;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ConfidentialInstanceConfig::class, 'Google_Service_AIPlatformNotebooks_ConfidentialInstanceConfig');

View File

@@ -1,105 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class Config extends \Google\Collection
{
protected $collection_key = 'availableImages';
protected $availableImagesType = ImageRelease::class;
protected $availableImagesDataType = 'array';
protected $defaultValuesType = DefaultValues::class;
protected $defaultValuesDataType = '';
/**
* Output only. Flag to disable the creation of legacy Workbench notebooks
* (User-managed notebooks and Google-managed notebooks).
*
* @var bool
*/
public $disableWorkbenchLegacyCreation;
protected $supportedValuesType = SupportedValues::class;
protected $supportedValuesDataType = '';
/**
* Output only. The list of available images to create a WbI.
*
* @param ImageRelease[] $availableImages
*/
public function setAvailableImages($availableImages)
{
$this->availableImages = $availableImages;
}
/**
* @return ImageRelease[]
*/
public function getAvailableImages()
{
return $this->availableImages;
}
/**
* Output only. The default values for configuration.
*
* @param DefaultValues $defaultValues
*/
public function setDefaultValues(DefaultValues $defaultValues)
{
$this->defaultValues = $defaultValues;
}
/**
* @return DefaultValues
*/
public function getDefaultValues()
{
return $this->defaultValues;
}
/**
* Output only. Flag to disable the creation of legacy Workbench notebooks
* (User-managed notebooks and Google-managed notebooks).
*
* @param bool $disableWorkbenchLegacyCreation
*/
public function setDisableWorkbenchLegacyCreation($disableWorkbenchLegacyCreation)
{
$this->disableWorkbenchLegacyCreation = $disableWorkbenchLegacyCreation;
}
/**
* @return bool
*/
public function getDisableWorkbenchLegacyCreation()
{
return $this->disableWorkbenchLegacyCreation;
}
/**
* Output only. The supported values for configuration.
*
* @param SupportedValues $supportedValues
*/
public function setSupportedValues(SupportedValues $supportedValues)
{
$this->supportedValues = $supportedValues;
}
/**
* @return SupportedValues
*/
public function getSupportedValues()
{
return $this->supportedValues;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Config::class, 'Google_Service_AIPlatformNotebooks_Config');

View File

@@ -1,74 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class ContainerImage extends \Google\Model
{
/**
* Required. The path to the container image repository. For example:
* `gcr.io/{project_id}/{image_name}`
*
* @var string
*/
public $repository;
/**
* Optional. The tag of the container image. If not specified, this defaults
* to the latest tag.
*
* @var string
*/
public $tag;
/**
* Required. The path to the container image repository. For example:
* `gcr.io/{project_id}/{image_name}`
*
* @param string $repository
*/
public function setRepository($repository)
{
$this->repository = $repository;
}
/**
* @return string
*/
public function getRepository()
{
return $this->repository;
}
/**
* Optional. The tag of the container image. If not specified, this defaults
* to the latest tag.
*
* @param string $tag
*/
public function setTag($tag)
{
$this->tag = $tag;
}
/**
* @return string
*/
public function getTag()
{
return $this->tag;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ContainerImage::class, 'Google_Service_AIPlatformNotebooks_ContainerImage');

View File

@@ -1,188 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class DataDisk extends \Google\Collection
{
/**
* Disk encryption is not specified.
*/
public const DISK_ENCRYPTION_DISK_ENCRYPTION_UNSPECIFIED = 'DISK_ENCRYPTION_UNSPECIFIED';
/**
* Use Google managed encryption keys to encrypt the boot disk.
*/
public const DISK_ENCRYPTION_GMEK = 'GMEK';
/**
* Use customer managed encryption keys to encrypt the boot disk.
*/
public const DISK_ENCRYPTION_CMEK = 'CMEK';
/**
* Disk type not set.
*/
public const DISK_TYPE_DISK_TYPE_UNSPECIFIED = 'DISK_TYPE_UNSPECIFIED';
/**
* Standard persistent disk type.
*/
public const DISK_TYPE_PD_STANDARD = 'PD_STANDARD';
/**
* SSD persistent disk type.
*/
public const DISK_TYPE_PD_SSD = 'PD_SSD';
/**
* Balanced persistent disk type.
*/
public const DISK_TYPE_PD_BALANCED = 'PD_BALANCED';
/**
* Extreme persistent disk type.
*/
public const DISK_TYPE_PD_EXTREME = 'PD_EXTREME';
/**
* Hyperdisk Balanced persistent disk type.
*/
public const DISK_TYPE_HYPERDISK_BALANCED = 'HYPERDISK_BALANCED';
protected $collection_key = 'resourcePolicies';
/**
* Optional. Input only. Disk encryption method used on the boot and data
* disks, defaults to GMEK.
*
* @var string
*/
public $diskEncryption;
/**
* Optional. The size of the disk in GB attached to this VM instance, up to a
* maximum of 64000 GB (64 TB). If not specified, this defaults to 100.
*
* @var string
*/
public $diskSizeGb;
/**
* Optional. Input only. Indicates the type of the disk.
*
* @var string
*/
public $diskType;
/**
* Optional. Input only. The KMS key used to encrypt the disks, only
* applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locat
* ions/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more
* about using your own encryption keys.
*
* @var string
*/
public $kmsKey;
/**
* Optional. The resource policies to apply to the data disk.
*
* @var string[]
*/
public $resourcePolicies;
/**
* Optional. Input only. Disk encryption method used on the boot and data
* disks, defaults to GMEK.
*
* Accepted values: DISK_ENCRYPTION_UNSPECIFIED, GMEK, CMEK
*
* @param self::DISK_ENCRYPTION_* $diskEncryption
*/
public function setDiskEncryption($diskEncryption)
{
$this->diskEncryption = $diskEncryption;
}
/**
* @return self::DISK_ENCRYPTION_*
*/
public function getDiskEncryption()
{
return $this->diskEncryption;
}
/**
* Optional. The size of the disk in GB attached to this VM instance, up to a
* maximum of 64000 GB (64 TB). If not specified, this defaults to 100.
*
* @param string $diskSizeGb
*/
public function setDiskSizeGb($diskSizeGb)
{
$this->diskSizeGb = $diskSizeGb;
}
/**
* @return string
*/
public function getDiskSizeGb()
{
return $this->diskSizeGb;
}
/**
* Optional. Input only. Indicates the type of the disk.
*
* Accepted values: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED,
* PD_EXTREME, HYPERDISK_BALANCED
*
* @param self::DISK_TYPE_* $diskType
*/
public function setDiskType($diskType)
{
$this->diskType = $diskType;
}
/**
* @return self::DISK_TYPE_*
*/
public function getDiskType()
{
return $this->diskType;
}
/**
* Optional. Input only. The KMS key used to encrypt the disks, only
* applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locat
* ions/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more
* about using your own encryption keys.
*
* @param string $kmsKey
*/
public function setKmsKey($kmsKey)
{
$this->kmsKey = $kmsKey;
}
/**
* @return string
*/
public function getKmsKey()
{
return $this->kmsKey;
}
/**
* Optional. The resource policies to apply to the data disk.
*
* @param string[] $resourcePolicies
*/
public function setResourcePolicies($resourcePolicies)
{
$this->resourcePolicies = $resourcePolicies;
}
/**
* @return string[]
*/
public function getResourcePolicies()
{
return $this->resourcePolicies;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DataDisk::class, 'Google_Service_AIPlatformNotebooks_DataDisk');

View File

@@ -1,44 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class DataprocParameters extends \Google\Model
{
/**
* @var string
*/
public $cluster;
/**
* @param string
*/
public function setCluster($cluster)
{
$this->cluster = $cluster;
}
/**
* @return string
*/
public function getCluster()
{
return $this->cluster;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DataprocParameters::class, 'Google_Service_AIPlatformNotebooks_DataprocParameters');

View File

@@ -1,50 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class DefaultValues extends \Google\Model
{
/**
* Output only. The default machine type used by the backend if not provided
* by the user.
*
* @var string
*/
public $machineType;
/**
* Output only. The default machine type used by the backend if not provided
* by the user.
*
* @param string $machineType
*/
public function setMachineType($machineType)
{
$this->machineType = $machineType;
}
/**
* @return string
*/
public function getMachineType()
{
return $this->machineType;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DefaultValues::class, 'Google_Service_AIPlatformNotebooks_DefaultValues');

View File

@@ -1,66 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class DiagnoseInstanceRequest extends \Google\Model
{
protected $diagnosticConfigType = DiagnosticConfig::class;
protected $diagnosticConfigDataType = '';
/**
* Optional. Maximum amount of time in minutes before the operation times out.
*
* @var int
*/
public $timeoutMinutes;
/**
* Required. Defines flags that are used to run the diagnostic tool
*
* @param DiagnosticConfig $diagnosticConfig
*/
public function setDiagnosticConfig(DiagnosticConfig $diagnosticConfig)
{
$this->diagnosticConfig = $diagnosticConfig;
}
/**
* @return DiagnosticConfig
*/
public function getDiagnosticConfig()
{
return $this->diagnosticConfig;
}
/**
* Optional. Maximum amount of time in minutes before the operation times out.
*
* @param int $timeoutMinutes
*/
public function setTimeoutMinutes($timeoutMinutes)
{
$this->timeoutMinutes = $timeoutMinutes;
}
/**
* @return int
*/
public function getTimeoutMinutes()
{
return $this->timeoutMinutes;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DiagnoseInstanceRequest::class, 'Google_Service_AIPlatformNotebooks_DiagnoseInstanceRequest');

View File

@@ -1,43 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class DiagnoseRuntimeRequest extends \Google\Model
{
protected $diagnosticConfigType = DiagnosticConfig::class;
protected $diagnosticConfigDataType = '';
public $diagnosticConfig;
/**
* @param DiagnosticConfig
*/
public function setDiagnosticConfig(DiagnosticConfig $diagnosticConfig)
{
$this->diagnosticConfig = $diagnosticConfig;
}
/**
* @return DiagnosticConfig
*/
public function getDiagnosticConfig()
{
return $this->diagnosticConfig;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DiagnoseRuntimeRequest::class, 'Google_Service_AIPlatformNotebooks_DiagnoseRuntimeRequest');

View File

@@ -1,156 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class DiagnosticConfig extends \Google\Model
{
/**
* Optional. Enables flag to copy all `/home/jupyter` folder contents
*
* @var bool
*/
public $enableCopyHomeFilesFlag;
/**
* Optional. Enables flag to capture packets from the instance for 30 seconds
*
* @var bool
*/
public $enablePacketCaptureFlag;
/**
* Optional. Enables flag to repair service for instance
*
* @var bool
*/
public $enableRepairFlag;
/**
* Required. User Cloud Storage bucket location (REQUIRED). Must be formatted
* with path prefix (`gs://$GCS_BUCKET`). Permissions: User Managed Notebooks:
* - storage.buckets.writer: Must be given to the project's service account
* attached to VM. Google Managed Notebooks: - storage.buckets.writer: Must be
* given to the project's service account or user credentials attached to VM
* depending on authentication mode. Cloud Storage bucket Log file will be
* written to `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
*
* @var string
*/
public $gcsBucket;
/**
* Optional. Defines the relative storage path in the Cloud Storage bucket
* where the diagnostic logs will be written: Default path will be the root
* directory of the Cloud Storage bucket
* (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`) Example of full path where Log file
* will be written: `gs://$GCS_BUCKET/$RELATIVE_PATH/`
*
* @var string
*/
public $relativePath;
/**
* Optional. Enables flag to copy all `/home/jupyter` folder contents
*
* @param bool $enableCopyHomeFilesFlag
*/
public function setEnableCopyHomeFilesFlag($enableCopyHomeFilesFlag)
{
$this->enableCopyHomeFilesFlag = $enableCopyHomeFilesFlag;
}
/**
* @return bool
*/
public function getEnableCopyHomeFilesFlag()
{
return $this->enableCopyHomeFilesFlag;
}
/**
* Optional. Enables flag to capture packets from the instance for 30 seconds
*
* @param bool $enablePacketCaptureFlag
*/
public function setEnablePacketCaptureFlag($enablePacketCaptureFlag)
{
$this->enablePacketCaptureFlag = $enablePacketCaptureFlag;
}
/**
* @return bool
*/
public function getEnablePacketCaptureFlag()
{
return $this->enablePacketCaptureFlag;
}
/**
* Optional. Enables flag to repair service for instance
*
* @param bool $enableRepairFlag
*/
public function setEnableRepairFlag($enableRepairFlag)
{
$this->enableRepairFlag = $enableRepairFlag;
}
/**
* @return bool
*/
public function getEnableRepairFlag()
{
return $this->enableRepairFlag;
}
/**
* Required. User Cloud Storage bucket location (REQUIRED). Must be formatted
* with path prefix (`gs://$GCS_BUCKET`). Permissions: User Managed Notebooks:
* - storage.buckets.writer: Must be given to the project's service account
* attached to VM. Google Managed Notebooks: - storage.buckets.writer: Must be
* given to the project's service account or user credentials attached to VM
* depending on authentication mode. Cloud Storage bucket Log file will be
* written to `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
*
* @param string $gcsBucket
*/
public function setGcsBucket($gcsBucket)
{
$this->gcsBucket = $gcsBucket;
}
/**
* @return string
*/
public function getGcsBucket()
{
return $this->gcsBucket;
}
/**
* Optional. Defines the relative storage path in the Cloud Storage bucket
* where the diagnostic logs will be written: Default path will be the root
* directory of the Cloud Storage bucket
* (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`) Example of full path where Log file
* will be written: `gs://$GCS_BUCKET/$RELATIVE_PATH/`
*
* @param string $relativePath
*/
public function setRelativePath($relativePath)
{
$this->relativePath = $relativePath;
}
/**
* @return string
*/
public function getRelativePath()
{
return $this->relativePath;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DiagnosticConfig::class, 'Google_Service_AIPlatformNotebooks_DiagnosticConfig');

View File

@@ -1,242 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class Disk extends \Google\Collection
{
protected $collection_key = 'licenses';
/**
* @var bool
*/
public $autoDelete;
/**
* @var bool
*/
public $boot;
/**
* @var string
*/
public $deviceName;
/**
* @var string
*/
public $diskSizeGb;
protected $guestOsFeaturesType = GuestOsFeature::class;
protected $guestOsFeaturesDataType = 'array';
public $guestOsFeatures = [];
/**
* @var string
*/
public $index;
/**
* @var string
*/
public $interface;
/**
* @var string
*/
public $kind;
/**
* @var string[]
*/
public $licenses = [];
/**
* @var string
*/
public $mode;
/**
* @var string
*/
public $source;
/**
* @var string
*/
public $type;
/**
* @param bool
*/
public function setAutoDelete($autoDelete)
{
$this->autoDelete = $autoDelete;
}
/**
* @return bool
*/
public function getAutoDelete()
{
return $this->autoDelete;
}
/**
* @param bool
*/
public function setBoot($boot)
{
$this->boot = $boot;
}
/**
* @return bool
*/
public function getBoot()
{
return $this->boot;
}
/**
* @param string
*/
public function setDeviceName($deviceName)
{
$this->deviceName = $deviceName;
}
/**
* @return string
*/
public function getDeviceName()
{
return $this->deviceName;
}
/**
* @param string
*/
public function setDiskSizeGb($diskSizeGb)
{
$this->diskSizeGb = $diskSizeGb;
}
/**
* @return string
*/
public function getDiskSizeGb()
{
return $this->diskSizeGb;
}
/**
* @param GuestOsFeature[]
*/
public function setGuestOsFeatures($guestOsFeatures)
{
$this->guestOsFeatures = $guestOsFeatures;
}
/**
* @return GuestOsFeature[]
*/
public function getGuestOsFeatures()
{
return $this->guestOsFeatures;
}
/**
* @param string
*/
public function setIndex($index)
{
$this->index = $index;
}
/**
* @return string
*/
public function getIndex()
{
return $this->index;
}
/**
* @param string
*/
public function setInterface($interface)
{
$this->interface = $interface;
}
/**
* @return string
*/
public function getInterface()
{
return $this->interface;
}
/**
* @param string
*/
public function setKind($kind)
{
$this->kind = $kind;
}
/**
* @return string
*/
public function getKind()
{
return $this->kind;
}
/**
* @param string[]
*/
public function setLicenses($licenses)
{
$this->licenses = $licenses;
}
/**
* @return string[]
*/
public function getLicenses()
{
return $this->licenses;
}
/**
* @param string
*/
public function setMode($mode)
{
$this->mode = $mode;
}
/**
* @return string
*/
public function getMode()
{
return $this->mode;
}
/**
* @param string
*/
public function setSource($source)
{
$this->source = $source;
}
/**
* @return string
*/
public function getSource()
{
return $this->source;
}
/**
* @param string
*/
public function setType($type)
{
$this->type = $type;
}
/**
* @return string
*/
public function getType()
{
return $this->type;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Disk::class, 'Google_Service_AIPlatformNotebooks_Disk');

View File

@@ -1,44 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class EncryptionConfig extends \Google\Model
{
/**
* @var string
*/
public $kmsKey;
/**
* @param string
*/
public function setKmsKey($kmsKey)
{
$this->kmsKey = $kmsKey;
}
/**
* @return string
*/
public function getKmsKey()
{
return $this->kmsKey;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(EncryptionConfig::class, 'Google_Service_AIPlatformNotebooks_EncryptionConfig');

View File

@@ -1,150 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class Environment extends \Google\Model
{
protected $containerImageType = ContainerImage::class;
protected $containerImageDataType = '';
public $containerImage;
/**
* @var string
*/
public $createTime;
/**
* @var string
*/
public $description;
/**
* @var string
*/
public $displayName;
/**
* @var string
*/
public $name;
/**
* @var string
*/
public $postStartupScript;
protected $vmImageType = VmImage::class;
protected $vmImageDataType = '';
public $vmImage;
/**
* @param ContainerImage
*/
public function setContainerImage(ContainerImage $containerImage)
{
$this->containerImage = $containerImage;
}
/**
* @return ContainerImage
*/
public function getContainerImage()
{
return $this->containerImage;
}
/**
* @param string
*/
public function setCreateTime($createTime)
{
$this->createTime = $createTime;
}
/**
* @return string
*/
public function getCreateTime()
{
return $this->createTime;
}
/**
* @param string
*/
public function setDescription($description)
{
$this->description = $description;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* @param string
*/
public function setDisplayName($displayName)
{
$this->displayName = $displayName;
}
/**
* @return string
*/
public function getDisplayName()
{
return $this->displayName;
}
/**
* @param string
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* @param string
*/
public function setPostStartupScript($postStartupScript)
{
$this->postStartupScript = $postStartupScript;
}
/**
* @return string
*/
public function getPostStartupScript()
{
return $this->postStartupScript;
}
/**
* @param VmImage
*/
public function setVmImage(VmImage $vmImage)
{
$this->vmImage = $vmImage;
}
/**
* @return VmImage
*/
public function getVmImage()
{
return $this->vmImage;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Environment::class, 'Google_Service_AIPlatformNotebooks_Environment');

View File

@@ -1,124 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class Event extends \Google\Model
{
/**
* Event is not specified.
*/
public const TYPE_EVENT_TYPE_UNSPECIFIED = 'EVENT_TYPE_UNSPECIFIED';
/**
* The instance / runtime is idle
*/
public const TYPE_IDLE = 'IDLE';
/**
* The instance / runtime is available. This event indicates that instance /
* runtime underlying compute is operational.
*/
public const TYPE_HEARTBEAT = 'HEARTBEAT';
/**
* The instance / runtime health is available. This event indicates that
* instance / runtime health information.
*/
public const TYPE_HEALTH = 'HEALTH';
/**
* The instance / runtime is available. This event allows instance / runtime
* to send Host maintenance information to Control Plane.
* https://cloud.google.com/compute/docs/gpus/gpu-host-maintenance
*/
public const TYPE_MAINTENANCE = 'MAINTENANCE';
/**
* The instance / runtime is available. This event indicates that the instance
* had metadata that needs to be modified.
*/
public const TYPE_METADATA_CHANGE = 'METADATA_CHANGE';
/**
* Optional. Event details. This field is used to pass event information.
*
* @var string[]
*/
public $details;
/**
* Optional. Event report time.
*
* @var string
*/
public $reportTime;
/**
* Optional. Event type.
*
* @var string
*/
public $type;
/**
* Optional. Event details. This field is used to pass event information.
*
* @param string[] $details
*/
public function setDetails($details)
{
$this->details = $details;
}
/**
* @return string[]
*/
public function getDetails()
{
return $this->details;
}
/**
* Optional. Event report time.
*
* @param string $reportTime
*/
public function setReportTime($reportTime)
{
$this->reportTime = $reportTime;
}
/**
* @return string
*/
public function getReportTime()
{
return $this->reportTime;
}
/**
* Optional. Event type.
*
* Accepted values: EVENT_TYPE_UNSPECIFIED, IDLE, HEARTBEAT, HEALTH,
* MAINTENANCE, METADATA_CHANGE
*
* @param self::TYPE_* $type
*/
public function setType($type)
{
$this->type = $type;
}
/**
* @return self::TYPE_*
*/
public function getType()
{
return $this->type;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Event::class, 'Google_Service_AIPlatformNotebooks_Event');

View File

@@ -1,187 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class Execution extends \Google\Model
{
/**
* @var string
*/
public $createTime;
/**
* @var string
*/
public $description;
/**
* @var string
*/
public $displayName;
protected $executionTemplateType = ExecutionTemplate::class;
protected $executionTemplateDataType = '';
public $executionTemplate;
/**
* @var string
*/
public $jobUri;
/**
* @var string
*/
public $name;
/**
* @var string
*/
public $outputNotebookFile;
/**
* @var string
*/
public $state;
/**
* @var string
*/
public $updateTime;
/**
* @param string
*/
public function setCreateTime($createTime)
{
$this->createTime = $createTime;
}
/**
* @return string
*/
public function getCreateTime()
{
return $this->createTime;
}
/**
* @param string
*/
public function setDescription($description)
{
$this->description = $description;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* @param string
*/
public function setDisplayName($displayName)
{
$this->displayName = $displayName;
}
/**
* @return string
*/
public function getDisplayName()
{
return $this->displayName;
}
/**
* @param ExecutionTemplate
*/
public function setExecutionTemplate(ExecutionTemplate $executionTemplate)
{
$this->executionTemplate = $executionTemplate;
}
/**
* @return ExecutionTemplate
*/
public function getExecutionTemplate()
{
return $this->executionTemplate;
}
/**
* @param string
*/
public function setJobUri($jobUri)
{
$this->jobUri = $jobUri;
}
/**
* @return string
*/
public function getJobUri()
{
return $this->jobUri;
}
/**
* @param string
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* @param string
*/
public function setOutputNotebookFile($outputNotebookFile)
{
$this->outputNotebookFile = $outputNotebookFile;
}
/**
* @return string
*/
public function getOutputNotebookFile()
{
return $this->outputNotebookFile;
}
/**
* @param string
*/
public function setState($state)
{
$this->state = $state;
}
/**
* @return string
*/
public function getState()
{
return $this->state;
}
/**
* @param string
*/
public function setUpdateTime($updateTime)
{
$this->updateTime = $updateTime;
}
/**
* @return string
*/
public function getUpdateTime()
{
return $this->updateTime;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Execution::class, 'Google_Service_AIPlatformNotebooks_Execution');

View File

@@ -1,293 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class ExecutionTemplate extends \Google\Model
{
protected $acceleratorConfigType = SchedulerAcceleratorConfig::class;
protected $acceleratorConfigDataType = '';
public $acceleratorConfig;
/**
* @var string
*/
public $containerImageUri;
protected $dataprocParametersType = DataprocParameters::class;
protected $dataprocParametersDataType = '';
public $dataprocParameters;
/**
* @var string
*/
public $inputNotebookFile;
/**
* @var string
*/
public $jobType;
/**
* @var string
*/
public $kernelSpec;
/**
* @var string[]
*/
public $labels = [];
/**
* @var string
*/
public $masterType;
/**
* @var string
*/
public $outputNotebookFolder;
/**
* @var string
*/
public $parameters;
/**
* @var string
*/
public $paramsYamlFile;
/**
* @var string
*/
public $scaleTier;
/**
* @var string
*/
public $serviceAccount;
/**
* @var string
*/
public $tensorboard;
protected $vertexAiParametersType = VertexAIParameters::class;
protected $vertexAiParametersDataType = '';
public $vertexAiParameters;
/**
* @param SchedulerAcceleratorConfig
*/
public function setAcceleratorConfig(SchedulerAcceleratorConfig $acceleratorConfig)
{
$this->acceleratorConfig = $acceleratorConfig;
}
/**
* @return SchedulerAcceleratorConfig
*/
public function getAcceleratorConfig()
{
return $this->acceleratorConfig;
}
/**
* @param string
*/
public function setContainerImageUri($containerImageUri)
{
$this->containerImageUri = $containerImageUri;
}
/**
* @return string
*/
public function getContainerImageUri()
{
return $this->containerImageUri;
}
/**
* @param DataprocParameters
*/
public function setDataprocParameters(DataprocParameters $dataprocParameters)
{
$this->dataprocParameters = $dataprocParameters;
}
/**
* @return DataprocParameters
*/
public function getDataprocParameters()
{
return $this->dataprocParameters;
}
/**
* @param string
*/
public function setInputNotebookFile($inputNotebookFile)
{
$this->inputNotebookFile = $inputNotebookFile;
}
/**
* @return string
*/
public function getInputNotebookFile()
{
return $this->inputNotebookFile;
}
/**
* @param string
*/
public function setJobType($jobType)
{
$this->jobType = $jobType;
}
/**
* @return string
*/
public function getJobType()
{
return $this->jobType;
}
/**
* @param string
*/
public function setKernelSpec($kernelSpec)
{
$this->kernelSpec = $kernelSpec;
}
/**
* @return string
*/
public function getKernelSpec()
{
return $this->kernelSpec;
}
/**
* @param string[]
*/
public function setLabels($labels)
{
$this->labels = $labels;
}
/**
* @return string[]
*/
public function getLabels()
{
return $this->labels;
}
/**
* @param string
*/
public function setMasterType($masterType)
{
$this->masterType = $masterType;
}
/**
* @return string
*/
public function getMasterType()
{
return $this->masterType;
}
/**
* @param string
*/
public function setOutputNotebookFolder($outputNotebookFolder)
{
$this->outputNotebookFolder = $outputNotebookFolder;
}
/**
* @return string
*/
public function getOutputNotebookFolder()
{
return $this->outputNotebookFolder;
}
/**
* @param string
*/
public function setParameters($parameters)
{
$this->parameters = $parameters;
}
/**
* @return string
*/
public function getParameters()
{
return $this->parameters;
}
/**
* @param string
*/
public function setParamsYamlFile($paramsYamlFile)
{
$this->paramsYamlFile = $paramsYamlFile;
}
/**
* @return string
*/
public function getParamsYamlFile()
{
return $this->paramsYamlFile;
}
/**
* @param string
*/
public function setScaleTier($scaleTier)
{
$this->scaleTier = $scaleTier;
}
/**
* @return string
*/
public function getScaleTier()
{
return $this->scaleTier;
}
/**
* @param string
*/
public function setServiceAccount($serviceAccount)
{
$this->serviceAccount = $serviceAccount;
}
/**
* @return string
*/
public function getServiceAccount()
{
return $this->serviceAccount;
}
/**
* @param string
*/
public function setTensorboard($tensorboard)
{
$this->tensorboard = $tensorboard;
}
/**
* @return string
*/
public function getTensorboard()
{
return $this->tensorboard;
}
/**
* @param VertexAIParameters
*/
public function setVertexAiParameters(VertexAIParameters $vertexAiParameters)
{
$this->vertexAiParameters = $vertexAiParameters;
}
/**
* @return VertexAIParameters
*/
public function getVertexAiParameters()
{
return $this->vertexAiParameters;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ExecutionTemplate::class, 'Google_Service_AIPlatformNotebooks_ExecutionTemplate');

View File

@@ -1,122 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class Expr extends \Google\Model
{
/**
* Optional. Description of the expression. This is a longer text which
* describes the expression, e.g. when hovered over it in a UI.
*
* @var string
*/
public $description;
/**
* Textual representation of an expression in Common Expression Language
* syntax.
*
* @var string
*/
public $expression;
/**
* Optional. String indicating the location of the expression for error
* reporting, e.g. a file name and a position in the file.
*
* @var string
*/
public $location;
/**
* Optional. Title for the expression, i.e. a short string describing its
* purpose. This can be used e.g. in UIs which allow to enter the expression.
*
* @var string
*/
public $title;
/**
* Optional. Description of the expression. This is a longer text which
* describes the expression, e.g. when hovered over it in a UI.
*
* @param string $description
*/
public function setDescription($description)
{
$this->description = $description;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* Textual representation of an expression in Common Expression Language
* syntax.
*
* @param string $expression
*/
public function setExpression($expression)
{
$this->expression = $expression;
}
/**
* @return string
*/
public function getExpression()
{
return $this->expression;
}
/**
* Optional. String indicating the location of the expression for error
* reporting, e.g. a file name and a position in the file.
*
* @param string $location
*/
public function setLocation($location)
{
$this->location = $location;
}
/**
* @return string
*/
public function getLocation()
{
return $this->location;
}
/**
* Optional. Title for the expression, i.e. a short string describing its
* purpose. This can be used e.g. in UIs which allow to enter the expression.
*
* @param string $title
*/
public function setTitle($title)
{
$this->title = $title;
}
/**
* @return string
*/
public function getTitle()
{
return $this->title;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Expr::class, 'Google_Service_AIPlatformNotebooks_Expr');

View File

@@ -1,78 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class GPUDriverConfig extends \Google\Model
{
/**
* Optional. Specify a custom Cloud Storage path where the GPU driver is
* stored. If not specified, we'll automatically choose from official GPU
* drivers.
*
* @var string
*/
public $customGpuDriverPath;
/**
* Optional. Whether the end user authorizes Google Cloud to install GPU
* driver on this VM instance. If this field is empty or set to false, the GPU
* driver won't be installed. Only applicable to instances with GPUs.
*
* @var bool
*/
public $enableGpuDriver;
/**
* Optional. Specify a custom Cloud Storage path where the GPU driver is
* stored. If not specified, we'll automatically choose from official GPU
* drivers.
*
* @param string $customGpuDriverPath
*/
public function setCustomGpuDriverPath($customGpuDriverPath)
{
$this->customGpuDriverPath = $customGpuDriverPath;
}
/**
* @return string
*/
public function getCustomGpuDriverPath()
{
return $this->customGpuDriverPath;
}
/**
* Optional. Whether the end user authorizes Google Cloud to install GPU
* driver on this VM instance. If this field is empty or set to false, the GPU
* driver won't be installed. Only applicable to instances with GPUs.
*
* @param bool $enableGpuDriver
*/
public function setEnableGpuDriver($enableGpuDriver)
{
$this->enableGpuDriver = $enableGpuDriver;
}
/**
* @return bool
*/
public function getEnableGpuDriver()
{
return $this->enableGpuDriver;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GPUDriverConfig::class, 'Google_Service_AIPlatformNotebooks_GPUDriverConfig');

View File

@@ -1,399 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class GceSetup extends \Google\Collection
{
protected $collection_key = 'tags';
protected $acceleratorConfigsType = AcceleratorConfig::class;
protected $acceleratorConfigsDataType = 'array';
protected $bootDiskType = BootDisk::class;
protected $bootDiskDataType = '';
protected $confidentialInstanceConfigType = ConfidentialInstanceConfig::class;
protected $confidentialInstanceConfigDataType = '';
protected $containerImageType = ContainerImage::class;
protected $containerImageDataType = '';
protected $dataDisksType = DataDisk::class;
protected $dataDisksDataType = 'array';
/**
* Optional. If true, no external IP will be assigned to this VM instance.
*
* @var bool
*/
public $disablePublicIp;
/**
* Optional. Flag to enable ip forwarding or not, default false/off.
* https://cloud.google.com/vpc/docs/using-routes#canipforward
*
* @var bool
*/
public $enableIpForwarding;
protected $gpuDriverConfigType = GPUDriverConfig::class;
protected $gpuDriverConfigDataType = '';
/**
* Output only. The unique ID of the Compute Engine instance resource.
*
* @var string
*/
public $instanceId;
/**
* Optional. The machine type of the VM instance.
* https://cloud.google.com/compute/docs/machine-resource
*
* @var string
*/
public $machineType;
/**
* Optional. Custom metadata to apply to this instance.
*
* @var string[]
*/
public $metadata;
/**
* Optional. The minimum CPU platform to use for this instance. The list of
* valid values can be found in
* https://cloud.google.com/compute/docs/instances/specify-min-cpu-
* platform#availablezones
*
* @var string
*/
public $minCpuPlatform;
protected $networkInterfacesType = NetworkInterface::class;
protected $networkInterfacesDataType = 'array';
protected $reservationAffinityType = ReservationAffinity::class;
protected $reservationAffinityDataType = '';
protected $serviceAccountsType = ServiceAccount::class;
protected $serviceAccountsDataType = 'array';
protected $shieldedInstanceConfigType = ShieldedInstanceConfig::class;
protected $shieldedInstanceConfigDataType = '';
/**
* Optional. The Compute Engine network tags to add to runtime (see [Add
* network tags](https://cloud.google.com/vpc/docs/add-remove-network-tags)).
*
* @var string[]
*/
public $tags;
protected $vmImageType = VmImage::class;
protected $vmImageDataType = '';
/**
* Optional. The hardware accelerators used on this instance. If you use
* accelerators, make sure that your configuration has [enough vCPUs and
* memory to support the `machine_type` you have
* selected](https://cloud.google.com/compute/docs/gpus/#gpus-list). Currently
* supports only one accelerator configuration.
*
* @param AcceleratorConfig[] $acceleratorConfigs
*/
public function setAcceleratorConfigs($acceleratorConfigs)
{
$this->acceleratorConfigs = $acceleratorConfigs;
}
/**
* @return AcceleratorConfig[]
*/
public function getAcceleratorConfigs()
{
return $this->acceleratorConfigs;
}
/**
* Optional. The boot disk for the VM.
*
* @param BootDisk $bootDisk
*/
public function setBootDisk(BootDisk $bootDisk)
{
$this->bootDisk = $bootDisk;
}
/**
* @return BootDisk
*/
public function getBootDisk()
{
return $this->bootDisk;
}
/**
* Optional. Confidential instance configuration.
*
* @param ConfidentialInstanceConfig $confidentialInstanceConfig
*/
public function setConfidentialInstanceConfig(ConfidentialInstanceConfig $confidentialInstanceConfig)
{
$this->confidentialInstanceConfig = $confidentialInstanceConfig;
}
/**
* @return ConfidentialInstanceConfig
*/
public function getConfidentialInstanceConfig()
{
return $this->confidentialInstanceConfig;
}
/**
* Optional. Use a container image to start the notebook instance.
*
* @param ContainerImage $containerImage
*/
public function setContainerImage(ContainerImage $containerImage)
{
$this->containerImage = $containerImage;
}
/**
* @return ContainerImage
*/
public function getContainerImage()
{
return $this->containerImage;
}
/**
* Optional. Data disks attached to the VM instance. Currently supports only
* one data disk.
*
* @param DataDisk[] $dataDisks
*/
public function setDataDisks($dataDisks)
{
$this->dataDisks = $dataDisks;
}
/**
* @return DataDisk[]
*/
public function getDataDisks()
{
return $this->dataDisks;
}
/**
* Optional. If true, no external IP will be assigned to this VM instance.
*
* @param bool $disablePublicIp
*/
public function setDisablePublicIp($disablePublicIp)
{
$this->disablePublicIp = $disablePublicIp;
}
/**
* @return bool
*/
public function getDisablePublicIp()
{
return $this->disablePublicIp;
}
/**
* Optional. Flag to enable ip forwarding or not, default false/off.
* https://cloud.google.com/vpc/docs/using-routes#canipforward
*
* @param bool $enableIpForwarding
*/
public function setEnableIpForwarding($enableIpForwarding)
{
$this->enableIpForwarding = $enableIpForwarding;
}
/**
* @return bool
*/
public function getEnableIpForwarding()
{
return $this->enableIpForwarding;
}
/**
* Optional. Configuration for GPU drivers.
*
* @param GPUDriverConfig $gpuDriverConfig
*/
public function setGpuDriverConfig(GPUDriverConfig $gpuDriverConfig)
{
$this->gpuDriverConfig = $gpuDriverConfig;
}
/**
* @return GPUDriverConfig
*/
public function getGpuDriverConfig()
{
return $this->gpuDriverConfig;
}
/**
* Output only. The unique ID of the Compute Engine instance resource.
*
* @param string $instanceId
*/
public function setInstanceId($instanceId)
{
$this->instanceId = $instanceId;
}
/**
* @return string
*/
public function getInstanceId()
{
return $this->instanceId;
}
/**
* Optional. The machine type of the VM instance.
* https://cloud.google.com/compute/docs/machine-resource
*
* @param string $machineType
*/
public function setMachineType($machineType)
{
$this->machineType = $machineType;
}
/**
* @return string
*/
public function getMachineType()
{
return $this->machineType;
}
/**
* Optional. Custom metadata to apply to this instance.
*
* @param string[] $metadata
*/
public function setMetadata($metadata)
{
$this->metadata = $metadata;
}
/**
* @return string[]
*/
public function getMetadata()
{
return $this->metadata;
}
/**
* Optional. The minimum CPU platform to use for this instance. The list of
* valid values can be found in
* https://cloud.google.com/compute/docs/instances/specify-min-cpu-
* platform#availablezones
*
* @param string $minCpuPlatform
*/
public function setMinCpuPlatform($minCpuPlatform)
{
$this->minCpuPlatform = $minCpuPlatform;
}
/**
* @return string
*/
public function getMinCpuPlatform()
{
return $this->minCpuPlatform;
}
/**
* Optional. The network interfaces for the VM. Supports only one interface.
*
* @param NetworkInterface[] $networkInterfaces
*/
public function setNetworkInterfaces($networkInterfaces)
{
$this->networkInterfaces = $networkInterfaces;
}
/**
* @return NetworkInterface[]
*/
public function getNetworkInterfaces()
{
return $this->networkInterfaces;
}
/**
* Optional. Specifies the reservations that this instance can consume from.
*
* @param ReservationAffinity $reservationAffinity
*/
public function setReservationAffinity(ReservationAffinity $reservationAffinity)
{
$this->reservationAffinity = $reservationAffinity;
}
/**
* @return ReservationAffinity
*/
public function getReservationAffinity()
{
return $this->reservationAffinity;
}
/**
* Optional. The service account that serves as an identity for the VM
* instance. Currently supports only one service account.
*
* @param ServiceAccount[] $serviceAccounts
*/
public function setServiceAccounts($serviceAccounts)
{
$this->serviceAccounts = $serviceAccounts;
}
/**
* @return ServiceAccount[]
*/
public function getServiceAccounts()
{
return $this->serviceAccounts;
}
/**
* Optional. Shielded VM configuration. [Images using supported Shielded VM
* features](https://cloud.google.com/compute/docs/instances/modifying-
* shielded-vm).
*
* @param ShieldedInstanceConfig $shieldedInstanceConfig
*/
public function setShieldedInstanceConfig(ShieldedInstanceConfig $shieldedInstanceConfig)
{
$this->shieldedInstanceConfig = $shieldedInstanceConfig;
}
/**
* @return ShieldedInstanceConfig
*/
public function getShieldedInstanceConfig()
{
return $this->shieldedInstanceConfig;
}
/**
* Optional. The Compute Engine network tags to add to runtime (see [Add
* network tags](https://cloud.google.com/vpc/docs/add-remove-network-tags)).
*
* @param string[] $tags
*/
public function setTags($tags)
{
$this->tags = $tags;
}
/**
* @return string[]
*/
public function getTags()
{
return $this->tags;
}
/**
* Optional. Use a Compute Engine VM image to start the notebook instance.
*
* @param VmImage $vmImage
*/
public function setVmImage(VmImage $vmImage)
{
$this->vmImage = $vmImage;
}
/**
* @return VmImage
*/
public function getVmImage()
{
return $this->vmImage;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GceSetup::class, 'Google_Service_AIPlatformNotebooks_GceSetup');

View File

@@ -1,50 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class GenerateAccessTokenRequest extends \Google\Model
{
/**
* Required. The VM identity token (a JWT) for authenticating the VM.
* https://cloud.google.com/compute/docs/instances/verifying-instance-identity
*
* @var string
*/
public $vmToken;
/**
* Required. The VM identity token (a JWT) for authenticating the VM.
* https://cloud.google.com/compute/docs/instances/verifying-instance-identity
*
* @param string $vmToken
*/
public function setVmToken($vmToken)
{
$this->vmToken = $vmToken;
}
/**
* @return string
*/
public function getVmToken()
{
return $this->vmToken;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GenerateAccessTokenRequest::class, 'Google_Service_AIPlatformNotebooks_GenerateAccessTokenRequest');

View File

@@ -1,125 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class GenerateAccessTokenResponse extends \Google\Model
{
protected $internal_gapi_mappings = [
"accessToken" => "access_token",
"expiresIn" => "expires_in",
"tokenType" => "token_type",
];
/**
* Short-lived access token string which may be used to access Google APIs.
*
* @var string
*/
public $accessToken;
/**
* The time in seconds when the access token expires. Typically that's 3600.
*
* @var int
*/
public $expiresIn;
/**
* Space-separated list of scopes contained in the returned token.
* https://cloud.google.com/docs/authentication/token-types#access-contents
*
* @var string
*/
public $scope;
/**
* Type of the returned access token (e.g. "Bearer"). It specifies how the
* token must be used. Bearer tokens may be used by any entity without proof
* of identity.
*
* @var string
*/
public $tokenType;
/**
* Short-lived access token string which may be used to access Google APIs.
*
* @param string $accessToken
*/
public function setAccessToken($accessToken)
{
$this->accessToken = $accessToken;
}
/**
* @return string
*/
public function getAccessToken()
{
return $this->accessToken;
}
/**
* The time in seconds when the access token expires. Typically that's 3600.
*
* @param int $expiresIn
*/
public function setExpiresIn($expiresIn)
{
$this->expiresIn = $expiresIn;
}
/**
* @return int
*/
public function getExpiresIn()
{
return $this->expiresIn;
}
/**
* Space-separated list of scopes contained in the returned token.
* https://cloud.google.com/docs/authentication/token-types#access-contents
*
* @param string $scope
*/
public function setScope($scope)
{
$this->scope = $scope;
}
/**
* @return string
*/
public function getScope()
{
return $this->scope;
}
/**
* Type of the returned access token (e.g. "Bearer"). It specifies how the
* token must be used. Bearer tokens may be used by any entity without proof
* of identity.
*
* @param string $tokenType
*/
public function setTokenType($tokenType)
{
$this->tokenType = $tokenType;
}
/**
* @return string
*/
public function getTokenType()
{
return $this->tokenType;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GenerateAccessTokenResponse::class, 'Google_Service_AIPlatformNotebooks_GenerateAccessTokenResponse');

View File

@@ -1,62 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class GetInstanceHealthResponse extends \Google\Model
{
/**
* @var string[]
*/
public $healthInfo = [];
/**
* @var string
*/
public $healthState;
/**
* @param string[]
*/
public function setHealthInfo($healthInfo)
{
$this->healthInfo = $healthInfo;
}
/**
* @return string[]
*/
public function getHealthInfo()
{
return $this->healthInfo;
}
/**
* @param string
*/
public function setHealthState($healthState)
{
$this->healthState = $healthState;
}
/**
* @return string
*/
public function getHealthState()
{
return $this->healthState;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GetInstanceHealthResponse::class, 'Google_Service_AIPlatformNotebooks_GetInstanceHealthResponse');

View File

@@ -1,44 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class GuestOsFeature extends \Google\Model
{
/**
* @var string
*/
public $type;
/**
* @param string
*/
public function setType($type)
{
$this->type = $type;
}
/**
* @return string
*/
public function getType()
{
return $this->type;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GuestOsFeature::class, 'Google_Service_AIPlatformNotebooks_GuestOsFeature');

View File

@@ -1,72 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class ImageRelease extends \Google\Model
{
/**
* Output only. The name of the image of the form workbench-instances-
* vYYYYmmdd--
*
* @var string
*/
public $imageName;
/**
* Output only. The release of the image of the form m123
*
* @var string
*/
public $releaseName;
/**
* Output only. The name of the image of the form workbench-instances-
* vYYYYmmdd--
*
* @param string $imageName
*/
public function setImageName($imageName)
{
$this->imageName = $imageName;
}
/**
* @return string
*/
public function getImageName()
{
return $this->imageName;
}
/**
* Output only. The release of the image of the form m123
*
* @param string $releaseName
*/
public function setReleaseName($releaseName)
{
$this->releaseName = $releaseName;
}
/**
* @return string
*/
public function getReleaseName()
{
return $this->releaseName;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ImageRelease::class, 'Google_Service_AIPlatformNotebooks_ImageRelease');

View File

@@ -1,563 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class Instance extends \Google\Collection
{
/**
* The instance substate is unknown.
*/
public const HEALTH_STATE_HEALTH_STATE_UNSPECIFIED = 'HEALTH_STATE_UNSPECIFIED';
/**
* The instance is known to be in an healthy state (for example, critical
* daemons are running) Applies to ACTIVE state.
*/
public const HEALTH_STATE_HEALTHY = 'HEALTHY';
/**
* The instance is known to be in an unhealthy state (for example, critical
* daemons are not running) Applies to ACTIVE state.
*/
public const HEALTH_STATE_UNHEALTHY = 'UNHEALTHY';
/**
* The instance has not installed health monitoring agent. Applies to ACTIVE
* state.
*/
public const HEALTH_STATE_AGENT_NOT_INSTALLED = 'AGENT_NOT_INSTALLED';
/**
* The instance health monitoring agent is not running. Applies to ACTIVE
* state.
*/
public const HEALTH_STATE_AGENT_NOT_RUNNING = 'AGENT_NOT_RUNNING';
/**
* State is not specified.
*/
public const STATE_STATE_UNSPECIFIED = 'STATE_UNSPECIFIED';
/**
* The control logic is starting the instance.
*/
public const STATE_STARTING = 'STARTING';
/**
* The control logic is installing required frameworks and registering the
* instance with notebook proxy
*/
public const STATE_PROVISIONING = 'PROVISIONING';
/**
* The instance is running.
*/
public const STATE_ACTIVE = 'ACTIVE';
/**
* The control logic is stopping the instance.
*/
public const STATE_STOPPING = 'STOPPING';
/**
* The instance is stopped.
*/
public const STATE_STOPPED = 'STOPPED';
/**
* The instance is deleted.
*/
public const STATE_DELETED = 'DELETED';
/**
* The instance is upgrading.
*/
public const STATE_UPGRADING = 'UPGRADING';
/**
* The instance is being created.
*/
public const STATE_INITIALIZING = 'INITIALIZING';
/**
* The instance is suspending.
*/
public const STATE_SUSPENDING = 'SUSPENDING';
/**
* The instance is suspended.
*/
public const STATE_SUSPENDED = 'SUSPENDED';
protected $collection_key = 'upgradeHistory';
/**
* Output only. Instance creation time.
*
* @var string
*/
public $createTime;
/**
* Output only. Email address of entity that sent original CreateInstance
* request.
*
* @var string
*/
public $creator;
/**
* Optional. If true, the notebook instance will not register with the proxy.
*
* @var bool
*/
public $disableProxyAccess;
/**
* Optional. If true, deletion protection will be enabled for this Workbench
* Instance. If false, deletion protection will be disabled for this Workbench
* Instance.
*
* @var bool
*/
public $enableDeletionProtection;
/**
* Optional. Flag to enable managed end user credentials for the instance.
*
* @var bool
*/
public $enableManagedEuc;
/**
* Optional. Flag that specifies that a notebook can be accessed with third
* party identity provider.
*
* @var bool
*/
public $enableThirdPartyIdentity;
protected $gceSetupType = GceSetup::class;
protected $gceSetupDataType = '';
/**
* Output only. Additional information about instance health. Example:
* healthInfo": { "docker_proxy_agent_status": "1", "docker_status": "1",
* "jupyterlab_api_status": "-1", "jupyterlab_status": "-1", "updated":
* "2020-10-18 09:40:03.573409" }
*
* @var string[]
*/
public $healthInfo;
/**
* Output only. Instance health_state.
*
* @var string
*/
public $healthState;
/**
* Output only. Unique ID of the resource.
*
* @var string
*/
public $id;
/**
* Optional. The owner of this instance after creation. Format:
* `alias@example.com` Currently supports one owner only. If not specified,
* all of the service account users of your VM instance's service account can
* use the instance.
*
* @var string[]
*/
public $instanceOwners;
/**
* Optional. Labels to apply to this instance. These can be later modified by
* the UpdateInstance method.
*
* @var string[]
*/
public $labels;
/**
* Output only. Identifier. The name of this notebook instance. Format:
* `projects/{project_id}/locations/{location}/instances/{instance_id}`
*
* @var string
*/
public $name;
/**
* Output only. The proxy endpoint that is used to access the Jupyter
* notebook.
*
* @var string
*/
public $proxyUri;
/**
* Output only. Reserved for future use for Zone Isolation.
*
* @var bool
*/
public $satisfiesPzi;
/**
* Output only. Reserved for future use for Zone Separation.
*
* @var bool
*/
public $satisfiesPzs;
/**
* Output only. The state of this instance.
*
* @var string
*/
public $state;
/**
* Output only. The workforce pools proxy endpoint that is used to access the
* Jupyter notebook.
*
* @var string
*/
public $thirdPartyProxyUrl;
/**
* Output only. Instance update time.
*
* @var string
*/
public $updateTime;
protected $upgradeHistoryType = UpgradeHistoryEntry::class;
protected $upgradeHistoryDataType = 'array';
/**
* Output only. Instance creation time.
*
* @param string $createTime
*/
public function setCreateTime($createTime)
{
$this->createTime = $createTime;
}
/**
* @return string
*/
public function getCreateTime()
{
return $this->createTime;
}
/**
* Output only. Email address of entity that sent original CreateInstance
* request.
*
* @param string $creator
*/
public function setCreator($creator)
{
$this->creator = $creator;
}
/**
* @return string
*/
public function getCreator()
{
return $this->creator;
}
/**
* Optional. If true, the notebook instance will not register with the proxy.
*
* @param bool $disableProxyAccess
*/
public function setDisableProxyAccess($disableProxyAccess)
{
$this->disableProxyAccess = $disableProxyAccess;
}
/**
* @return bool
*/
public function getDisableProxyAccess()
{
return $this->disableProxyAccess;
}
/**
* Optional. If true, deletion protection will be enabled for this Workbench
* Instance. If false, deletion protection will be disabled for this Workbench
* Instance.
*
* @param bool $enableDeletionProtection
*/
public function setEnableDeletionProtection($enableDeletionProtection)
{
$this->enableDeletionProtection = $enableDeletionProtection;
}
/**
* @return bool
*/
public function getEnableDeletionProtection()
{
return $this->enableDeletionProtection;
}
/**
* Optional. Flag to enable managed end user credentials for the instance.
*
* @param bool $enableManagedEuc
*/
public function setEnableManagedEuc($enableManagedEuc)
{
$this->enableManagedEuc = $enableManagedEuc;
}
/**
* @return bool
*/
public function getEnableManagedEuc()
{
return $this->enableManagedEuc;
}
/**
* Optional. Flag that specifies that a notebook can be accessed with third
* party identity provider.
*
* @param bool $enableThirdPartyIdentity
*/
public function setEnableThirdPartyIdentity($enableThirdPartyIdentity)
{
$this->enableThirdPartyIdentity = $enableThirdPartyIdentity;
}
/**
* @return bool
*/
public function getEnableThirdPartyIdentity()
{
return $this->enableThirdPartyIdentity;
}
/**
* Optional. Compute Engine setup for the notebook. Uses notebook-defined
* fields.
*
* @param GceSetup $gceSetup
*/
public function setGceSetup(GceSetup $gceSetup)
{
$this->gceSetup = $gceSetup;
}
/**
* @return GceSetup
*/
public function getGceSetup()
{
return $this->gceSetup;
}
/**
* Output only. Additional information about instance health. Example:
* healthInfo": { "docker_proxy_agent_status": "1", "docker_status": "1",
* "jupyterlab_api_status": "-1", "jupyterlab_status": "-1", "updated":
* "2020-10-18 09:40:03.573409" }
*
* @param string[] $healthInfo
*/
public function setHealthInfo($healthInfo)
{
$this->healthInfo = $healthInfo;
}
/**
* @return string[]
*/
public function getHealthInfo()
{
return $this->healthInfo;
}
/**
* Output only. Instance health_state.
*
* Accepted values: HEALTH_STATE_UNSPECIFIED, HEALTHY, UNHEALTHY,
* AGENT_NOT_INSTALLED, AGENT_NOT_RUNNING
*
* @param self::HEALTH_STATE_* $healthState
*/
public function setHealthState($healthState)
{
$this->healthState = $healthState;
}
/**
* @return self::HEALTH_STATE_*
*/
public function getHealthState()
{
return $this->healthState;
}
/**
* Output only. Unique ID of the resource.
*
* @param string $id
*/
public function setId($id)
{
$this->id = $id;
}
/**
* @return string
*/
public function getId()
{
return $this->id;
}
/**
* Optional. The owner of this instance after creation. Format:
* `alias@example.com` Currently supports one owner only. If not specified,
* all of the service account users of your VM instance's service account can
* use the instance.
*
* @param string[] $instanceOwners
*/
public function setInstanceOwners($instanceOwners)
{
$this->instanceOwners = $instanceOwners;
}
/**
* @return string[]
*/
public function getInstanceOwners()
{
return $this->instanceOwners;
}
/**
* Optional. Labels to apply to this instance. These can be later modified by
* the UpdateInstance method.
*
* @param string[] $labels
*/
public function setLabels($labels)
{
$this->labels = $labels;
}
/**
* @return string[]
*/
public function getLabels()
{
return $this->labels;
}
/**
* Output only. Identifier. The name of this notebook instance. Format:
* `projects/{project_id}/locations/{location}/instances/{instance_id}`
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Output only. The proxy endpoint that is used to access the Jupyter
* notebook.
*
* @param string $proxyUri
*/
public function setProxyUri($proxyUri)
{
$this->proxyUri = $proxyUri;
}
/**
* @return string
*/
public function getProxyUri()
{
return $this->proxyUri;
}
/**
* Output only. Reserved for future use for Zone Isolation.
*
* @param bool $satisfiesPzi
*/
public function setSatisfiesPzi($satisfiesPzi)
{
$this->satisfiesPzi = $satisfiesPzi;
}
/**
* @return bool
*/
public function getSatisfiesPzi()
{
return $this->satisfiesPzi;
}
/**
* Output only. Reserved for future use for Zone Separation.
*
* @param bool $satisfiesPzs
*/
public function setSatisfiesPzs($satisfiesPzs)
{
$this->satisfiesPzs = $satisfiesPzs;
}
/**
* @return bool
*/
public function getSatisfiesPzs()
{
return $this->satisfiesPzs;
}
/**
* Output only. The state of this instance.
*
* Accepted values: STATE_UNSPECIFIED, STARTING, PROVISIONING, ACTIVE,
* STOPPING, STOPPED, DELETED, UPGRADING, INITIALIZING, SUSPENDING, SUSPENDED
*
* @param self::STATE_* $state
*/
public function setState($state)
{
$this->state = $state;
}
/**
* @return self::STATE_*
*/
public function getState()
{
return $this->state;
}
/**
* Output only. The workforce pools proxy endpoint that is used to access the
* Jupyter notebook.
*
* @param string $thirdPartyProxyUrl
*/
public function setThirdPartyProxyUrl($thirdPartyProxyUrl)
{
$this->thirdPartyProxyUrl = $thirdPartyProxyUrl;
}
/**
* @return string
*/
public function getThirdPartyProxyUrl()
{
return $this->thirdPartyProxyUrl;
}
/**
* Output only. Instance update time.
*
* @param string $updateTime
*/
public function setUpdateTime($updateTime)
{
$this->updateTime = $updateTime;
}
/**
* @return string
*/
public function getUpdateTime()
{
return $this->updateTime;
}
/**
* Output only. The upgrade history of this instance.
*
* @param UpgradeHistoryEntry[] $upgradeHistory
*/
public function setUpgradeHistory($upgradeHistory)
{
$this->upgradeHistory = $upgradeHistory;
}
/**
* @return UpgradeHistoryEntry[]
*/
public function getUpgradeHistory()
{
return $this->upgradeHistory;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Instance::class, 'Google_Service_AIPlatformNotebooks_Instance');

View File

@@ -1,62 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class InstanceConfig extends \Google\Model
{
/**
* @var bool
*/
public $enableHealthMonitoring;
/**
* @var string
*/
public $notebookUpgradeSchedule;
/**
* @param bool
*/
public function setEnableHealthMonitoring($enableHealthMonitoring)
{
$this->enableHealthMonitoring = $enableHealthMonitoring;
}
/**
* @return bool
*/
public function getEnableHealthMonitoring()
{
return $this->enableHealthMonitoring;
}
/**
* @param string
*/
public function setNotebookUpgradeSchedule($notebookUpgradeSchedule)
{
$this->notebookUpgradeSchedule = $notebookUpgradeSchedule;
}
/**
* @return string
*/
public function getNotebookUpgradeSchedule()
{
return $this->notebookUpgradeSchedule;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(InstanceConfig::class, 'Google_Service_AIPlatformNotebooks_InstanceConfig');

View File

@@ -1,98 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class IsInstanceUpgradeableResponse extends \Google\Model
{
/**
* @var string
*/
public $upgradeImage;
/**
* @var string
*/
public $upgradeInfo;
/**
* @var string
*/
public $upgradeVersion;
/**
* @var bool
*/
public $upgradeable;
/**
* @param string
*/
public function setUpgradeImage($upgradeImage)
{
$this->upgradeImage = $upgradeImage;
}
/**
* @return string
*/
public function getUpgradeImage()
{
return $this->upgradeImage;
}
/**
* @param string
*/
public function setUpgradeInfo($upgradeInfo)
{
$this->upgradeInfo = $upgradeInfo;
}
/**
* @return string
*/
public function getUpgradeInfo()
{
return $this->upgradeInfo;
}
/**
* @param string
*/
public function setUpgradeVersion($upgradeVersion)
{
$this->upgradeVersion = $upgradeVersion;
}
/**
* @return string
*/
public function getUpgradeVersion()
{
return $this->upgradeVersion;
}
/**
* @param bool
*/
public function setUpgradeable($upgradeable)
{
$this->upgradeable = $upgradeable;
}
/**
* @return bool
*/
public function getUpgradeable()
{
return $this->upgradeable;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(IsInstanceUpgradeableResponse::class, 'Google_Service_AIPlatformNotebooks_IsInstanceUpgradeableResponse');

View File

@@ -1,80 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class ListEnvironmentsResponse extends \Google\Collection
{
protected $collection_key = 'unreachable';
protected $environmentsType = Environment::class;
protected $environmentsDataType = 'array';
public $environments = [];
/**
* @var string
*/
public $nextPageToken;
/**
* @var string[]
*/
public $unreachable = [];
/**
* @param Environment[]
*/
public function setEnvironments($environments)
{
$this->environments = $environments;
}
/**
* @return Environment[]
*/
public function getEnvironments()
{
return $this->environments;
}
/**
* @param string
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
/**
* @param string[]
*/
public function setUnreachable($unreachable)
{
$this->unreachable = $unreachable;
}
/**
* @return string[]
*/
public function getUnreachable()
{
return $this->unreachable;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListEnvironmentsResponse::class, 'Google_Service_AIPlatformNotebooks_ListEnvironmentsResponse');

View File

@@ -1,80 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class ListExecutionsResponse extends \Google\Collection
{
protected $collection_key = 'unreachable';
protected $executionsType = Execution::class;
protected $executionsDataType = 'array';
public $executions = [];
/**
* @var string
*/
public $nextPageToken;
/**
* @var string[]
*/
public $unreachable = [];
/**
* @param Execution[]
*/
public function setExecutions($executions)
{
$this->executions = $executions;
}
/**
* @return Execution[]
*/
public function getExecutions()
{
return $this->executions;
}
/**
* @param string
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
/**
* @param string[]
*/
public function setUnreachable($unreachable)
{
$this->unreachable = $unreachable;
}
/**
* @return string[]
*/
public function getUnreachable()
{
return $this->unreachable;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListExecutionsResponse::class, 'Google_Service_AIPlatformNotebooks_ListExecutionsResponse');

View File

@@ -1,95 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class ListInstancesResponse extends \Google\Collection
{
protected $collection_key = 'unreachable';
protected $instancesType = Instance::class;
protected $instancesDataType = 'array';
/**
* Page token that can be used to continue listing from the last result in the
* next list call.
*
* @var string
*/
public $nextPageToken;
/**
* Locations that could not be reached. For example, ['us-west1-a', 'us-
* central1-b']. A ListInstancesResponse will only contain either instances or
* unreachables,
*
* @var string[]
*/
public $unreachable;
/**
* A list of returned instances.
*
* @param Instance[] $instances
*/
public function setInstances($instances)
{
$this->instances = $instances;
}
/**
* @return Instance[]
*/
public function getInstances()
{
return $this->instances;
}
/**
* Page token that can be used to continue listing from the last result in the
* next list call.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
/**
* Locations that could not be reached. For example, ['us-west1-a', 'us-
* central1-b']. A ListInstancesResponse will only contain either instances or
* unreachables,
*
* @param string[] $unreachable
*/
public function setUnreachable($unreachable)
{
$this->unreachable = $unreachable;
}
/**
* @return string[]
*/
public function getUnreachable()
{
return $this->unreachable;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListInstancesResponse::class, 'Google_Service_AIPlatformNotebooks_ListInstancesResponse');

View File

@@ -1,67 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class ListLocationsResponse extends \Google\Collection
{
protected $collection_key = 'locations';
protected $locationsType = Location::class;
protected $locationsDataType = 'array';
/**
* The standard List next-page token.
*
* @var string
*/
public $nextPageToken;
/**
* A list of locations that matches the specified filter in the request.
*
* @param Location[] $locations
*/
public function setLocations($locations)
{
$this->locations = $locations;
}
/**
* @return Location[]
*/
public function getLocations()
{
return $this->locations;
}
/**
* The standard List next-page token.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListLocationsResponse::class, 'Google_Service_AIPlatformNotebooks_ListLocationsResponse');

View File

@@ -1,95 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class ListOperationsResponse extends \Google\Collection
{
protected $collection_key = 'unreachable';
/**
* The standard List next-page token.
*
* @var string
*/
public $nextPageToken;
protected $operationsType = Operation::class;
protected $operationsDataType = 'array';
/**
* Unordered list. Unreachable resources. Populated when the request sets
* `ListOperationsRequest.return_partial_success` and reads across
* collections. For example, when attempting to list all resources across all
* supported locations.
*
* @var string[]
*/
public $unreachable;
/**
* The standard List next-page token.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
/**
* A list of operations that matches the specified filter in the request.
*
* @param Operation[] $operations
*/
public function setOperations($operations)
{
$this->operations = $operations;
}
/**
* @return Operation[]
*/
public function getOperations()
{
return $this->operations;
}
/**
* Unordered list. Unreachable resources. Populated when the request sets
* `ListOperationsRequest.return_partial_success` and reads across
* collections. For example, when attempting to list all resources across all
* supported locations.
*
* @param string[] $unreachable
*/
public function setUnreachable($unreachable)
{
$this->unreachable = $unreachable;
}
/**
* @return string[]
*/
public function getUnreachable()
{
return $this->unreachable;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListOperationsResponse::class, 'Google_Service_AIPlatformNotebooks_ListOperationsResponse');

View File

@@ -1,80 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class ListRuntimesResponse extends \Google\Collection
{
protected $collection_key = 'unreachable';
/**
* @var string
*/
public $nextPageToken;
protected $runtimesType = Runtime::class;
protected $runtimesDataType = 'array';
public $runtimes = [];
/**
* @var string[]
*/
public $unreachable = [];
/**
* @param string
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
/**
* @param Runtime[]
*/
public function setRuntimes($runtimes)
{
$this->runtimes = $runtimes;
}
/**
* @return Runtime[]
*/
public function getRuntimes()
{
return $this->runtimes;
}
/**
* @param string[]
*/
public function setUnreachable($unreachable)
{
$this->unreachable = $unreachable;
}
/**
* @return string[]
*/
public function getUnreachable()
{
return $this->unreachable;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListRuntimesResponse::class, 'Google_Service_AIPlatformNotebooks_ListRuntimesResponse');

View File

@@ -1,80 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class ListSchedulesResponse extends \Google\Collection
{
protected $collection_key = 'unreachable';
/**
* @var string
*/
public $nextPageToken;
protected $schedulesType = Schedule::class;
protected $schedulesDataType = 'array';
public $schedules = [];
/**
* @var string[]
*/
public $unreachable = [];
/**
* @param string
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
/**
* @param Schedule[]
*/
public function setSchedules($schedules)
{
$this->schedules = $schedules;
}
/**
* @return Schedule[]
*/
public function getSchedules()
{
return $this->schedules;
}
/**
* @param string[]
*/
public function setUnreachable($unreachable)
{
$this->unreachable = $unreachable;
}
/**
* @return string[]
*/
public function getUnreachable()
{
return $this->unreachable;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListSchedulesResponse::class, 'Google_Service_AIPlatformNotebooks_ListSchedulesResponse');

View File

@@ -1,241 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class LocalDisk extends \Google\Collection
{
protected $collection_key = 'licenses';
/**
* @var bool
*/
public $autoDelete;
/**
* @var bool
*/
public $boot;
/**
* @var string
*/
public $deviceName;
protected $guestOsFeaturesType = RuntimeGuestOsFeature::class;
protected $guestOsFeaturesDataType = 'array';
public $guestOsFeatures = [];
/**
* @var int
*/
public $index;
protected $initializeParamsType = LocalDiskInitializeParams::class;
protected $initializeParamsDataType = '';
public $initializeParams;
/**
* @var string
*/
public $interface;
/**
* @var string
*/
public $kind;
/**
* @var string[]
*/
public $licenses = [];
/**
* @var string
*/
public $mode;
/**
* @var string
*/
public $source;
/**
* @var string
*/
public $type;
/**
* @param bool
*/
public function setAutoDelete($autoDelete)
{
$this->autoDelete = $autoDelete;
}
/**
* @return bool
*/
public function getAutoDelete()
{
return $this->autoDelete;
}
/**
* @param bool
*/
public function setBoot($boot)
{
$this->boot = $boot;
}
/**
* @return bool
*/
public function getBoot()
{
return $this->boot;
}
/**
* @param string
*/
public function setDeviceName($deviceName)
{
$this->deviceName = $deviceName;
}
/**
* @return string
*/
public function getDeviceName()
{
return $this->deviceName;
}
/**
* @param RuntimeGuestOsFeature[]
*/
public function setGuestOsFeatures($guestOsFeatures)
{
$this->guestOsFeatures = $guestOsFeatures;
}
/**
* @return RuntimeGuestOsFeature[]
*/
public function getGuestOsFeatures()
{
return $this->guestOsFeatures;
}
/**
* @param int
*/
public function setIndex($index)
{
$this->index = $index;
}
/**
* @return int
*/
public function getIndex()
{
return $this->index;
}
/**
* @param LocalDiskInitializeParams
*/
public function setInitializeParams(LocalDiskInitializeParams $initializeParams)
{
$this->initializeParams = $initializeParams;
}
/**
* @return LocalDiskInitializeParams
*/
public function getInitializeParams()
{
return $this->initializeParams;
}
/**
* @param string
*/
public function setInterface($interface)
{
$this->interface = $interface;
}
/**
* @return string
*/
public function getInterface()
{
return $this->interface;
}
/**
* @param string
*/
public function setKind($kind)
{
$this->kind = $kind;
}
/**
* @return string
*/
public function getKind()
{
return $this->kind;
}
/**
* @param string[]
*/
public function setLicenses($licenses)
{
$this->licenses = $licenses;
}
/**
* @return string[]
*/
public function getLicenses()
{
return $this->licenses;
}
/**
* @param string
*/
public function setMode($mode)
{
$this->mode = $mode;
}
/**
* @return string
*/
public function getMode()
{
return $this->mode;
}
/**
* @param string
*/
public function setSource($source)
{
$this->source = $source;
}
/**
* @return string
*/
public function getSource()
{
return $this->source;
}
/**
* @param string
*/
public function setType($type)
{
$this->type = $type;
}
/**
* @return string
*/
public function getType()
{
return $this->type;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(LocalDisk::class, 'Google_Service_AIPlatformNotebooks_LocalDisk');

View File

@@ -1,116 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class LocalDiskInitializeParams extends \Google\Model
{
/**
* @var string
*/
public $description;
/**
* @var string
*/
public $diskName;
/**
* @var string
*/
public $diskSizeGb;
/**
* @var string
*/
public $diskType;
/**
* @var string[]
*/
public $labels = [];
/**
* @param string
*/
public function setDescription($description)
{
$this->description = $description;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* @param string
*/
public function setDiskName($diskName)
{
$this->diskName = $diskName;
}
/**
* @return string
*/
public function getDiskName()
{
return $this->diskName;
}
/**
* @param string
*/
public function setDiskSizeGb($diskSizeGb)
{
$this->diskSizeGb = $diskSizeGb;
}
/**
* @return string
*/
public function getDiskSizeGb()
{
return $this->diskSizeGb;
}
/**
* @param string
*/
public function setDiskType($diskType)
{
$this->diskType = $diskType;
}
/**
* @return string
*/
public function getDiskType()
{
return $this->diskType;
}
/**
* @param string[]
*/
public function setLabels($labels)
{
$this->labels = $labels;
}
/**
* @return string[]
*/
public function getLabels()
{
return $this->labels;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(LocalDiskInitializeParams::class, 'Google_Service_AIPlatformNotebooks_LocalDiskInitializeParams');

View File

@@ -1,144 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class Location extends \Google\Model
{
/**
* The friendly name for this location, typically a nearby city name. For
* example, "Tokyo".
*
* @var string
*/
public $displayName;
/**
* Cross-service attributes for the location. For example
* {"cloud.googleapis.com/region": "us-east1"}
*
* @var string[]
*/
public $labels;
/**
* The canonical id for this location. For example: `"us-east1"`.
*
* @var string
*/
public $locationId;
/**
* Service-specific metadata. For example the available capacity at the given
* location.
*
* @var array[]
*/
public $metadata;
/**
* Resource name for the location, which may vary between implementations. For
* example: `"projects/example-project/locations/us-east1"`
*
* @var string
*/
public $name;
/**
* The friendly name for this location, typically a nearby city name. For
* example, "Tokyo".
*
* @param string $displayName
*/
public function setDisplayName($displayName)
{
$this->displayName = $displayName;
}
/**
* @return string
*/
public function getDisplayName()
{
return $this->displayName;
}
/**
* Cross-service attributes for the location. For example
* {"cloud.googleapis.com/region": "us-east1"}
*
* @param string[] $labels
*/
public function setLabels($labels)
{
$this->labels = $labels;
}
/**
* @return string[]
*/
public function getLabels()
{
return $this->labels;
}
/**
* The canonical id for this location. For example: `"us-east1"`.
*
* @param string $locationId
*/
public function setLocationId($locationId)
{
$this->locationId = $locationId;
}
/**
* @return string
*/
public function getLocationId()
{
return $this->locationId;
}
/**
* Service-specific metadata. For example the available capacity at the given
* location.
*
* @param array[] $metadata
*/
public function setMetadata($metadata)
{
$this->metadata = $metadata;
}
/**
* @return array[]
*/
public function getMetadata()
{
return $this->metadata;
}
/**
* Resource name for the location, which may vary between implementations. For
* example: `"projects/example-project/locations/us-east1"`
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Location::class, 'Google_Service_AIPlatformNotebooks_Location');

View File

@@ -1,134 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class NetworkInterface extends \Google\Collection
{
/**
* No type specified.
*/
public const NIC_TYPE_NIC_TYPE_UNSPECIFIED = 'NIC_TYPE_UNSPECIFIED';
/**
* VIRTIO
*/
public const NIC_TYPE_VIRTIO_NET = 'VIRTIO_NET';
/**
* GVNIC
*/
public const NIC_TYPE_GVNIC = 'GVNIC';
protected $collection_key = 'accessConfigs';
protected $accessConfigsType = AccessConfig::class;
protected $accessConfigsDataType = 'array';
/**
* Optional. The name of the VPC that this VM instance is in. Format:
* `projects/{project_id}/global/networks/{network_id}`
*
* @var string
*/
public $network;
/**
* Optional. The type of vNIC to be used on this interface. This may be gVNIC
* or VirtioNet.
*
* @var string
*/
public $nicType;
/**
* Optional. The name of the subnet that this VM instance is in. Format:
* `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`
*
* @var string
*/
public $subnet;
/**
* Optional. An array of configurations for this interface. Currently, only
* one access config, ONE_TO_ONE_NAT, is supported. If no accessConfigs
* specified, the instance will have an external internet access through an
* ephemeral external IP address.
*
* @param AccessConfig[] $accessConfigs
*/
public function setAccessConfigs($accessConfigs)
{
$this->accessConfigs = $accessConfigs;
}
/**
* @return AccessConfig[]
*/
public function getAccessConfigs()
{
return $this->accessConfigs;
}
/**
* Optional. The name of the VPC that this VM instance is in. Format:
* `projects/{project_id}/global/networks/{network_id}`
*
* @param string $network
*/
public function setNetwork($network)
{
$this->network = $network;
}
/**
* @return string
*/
public function getNetwork()
{
return $this->network;
}
/**
* Optional. The type of vNIC to be used on this interface. This may be gVNIC
* or VirtioNet.
*
* Accepted values: NIC_TYPE_UNSPECIFIED, VIRTIO_NET, GVNIC
*
* @param self::NIC_TYPE_* $nicType
*/
public function setNicType($nicType)
{
$this->nicType = $nicType;
}
/**
* @return self::NIC_TYPE_*
*/
public function getNicType()
{
return $this->nicType;
}
/**
* Optional. The name of the subnet that this VM instance is in. Format:
* `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`
*
* @param string $subnet
*/
public function setSubnet($subnet)
{
$this->subnet = $subnet;
}
/**
* @return string
*/
public function getSubnet()
{
return $this->subnet;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(NetworkInterface::class, 'Google_Service_AIPlatformNotebooks_NetworkInterface');

View File

@@ -1,25 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class NotebooksEmpty extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(NotebooksEmpty::class, 'Google_Service_AIPlatformNotebooks_NotebooksEmpty');

View File

@@ -1,158 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class Operation extends \Google\Model
{
/**
* If the value is `false`, it means the operation is still in progress. If
* `true`, the operation is completed, and either `error` or `response` is
* available.
*
* @var bool
*/
public $done;
protected $errorType = Status::class;
protected $errorDataType = '';
/**
* Service-specific metadata associated with the operation. It typically
* contains progress information and common metadata such as create time. Some
* services might not provide such metadata. Any method that returns a long-
* running operation should document the metadata type, if any.
*
* @var array[]
*/
public $metadata;
/**
* The server-assigned name, which is only unique within the same service that
* originally returns it. If you use the default HTTP mapping, the `name`
* should be a resource name ending with `operations/{unique_id}`.
*
* @var string
*/
public $name;
/**
* The normal, successful response of the operation. If the original method
* returns no data on success, such as `Delete`, the response is
* `google.protobuf.Empty`. If the original method is standard
* `Get`/`Create`/`Update`, the response should be the resource. For other
* methods, the response should have the type `XxxResponse`, where `Xxx` is
* the original method name. For example, if the original method name is
* `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*
* @var array[]
*/
public $response;
/**
* If the value is `false`, it means the operation is still in progress. If
* `true`, the operation is completed, and either `error` or `response` is
* available.
*
* @param bool $done
*/
public function setDone($done)
{
$this->done = $done;
}
/**
* @return bool
*/
public function getDone()
{
return $this->done;
}
/**
* The error result of the operation in case of failure or cancellation.
*
* @param Status $error
*/
public function setError(Status $error)
{
$this->error = $error;
}
/**
* @return Status
*/
public function getError()
{
return $this->error;
}
/**
* Service-specific metadata associated with the operation. It typically
* contains progress information and common metadata such as create time. Some
* services might not provide such metadata. Any method that returns a long-
* running operation should document the metadata type, if any.
*
* @param array[] $metadata
*/
public function setMetadata($metadata)
{
$this->metadata = $metadata;
}
/**
* @return array[]
*/
public function getMetadata()
{
return $this->metadata;
}
/**
* The server-assigned name, which is only unique within the same service that
* originally returns it. If you use the default HTTP mapping, the `name`
* should be a resource name ending with `operations/{unique_id}`.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* The normal, successful response of the operation. If the original method
* returns no data on success, such as `Delete`, the response is
* `google.protobuf.Empty`. If the original method is standard
* `Get`/`Create`/`Update`, the response should be the resource. For other
* methods, the response should have the type `XxxResponse`, where `Xxx` is
* the original method name. For example, if the original method name is
* `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*
* @param array[] $response
*/
public function setResponse($response)
{
$this->response = $response;
}
/**
* @return array[]
*/
public function getResponse()
{
return $this->response;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Operation::class, 'Google_Service_AIPlatformNotebooks_Operation');

View File

@@ -1,208 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class OperationMetadata extends \Google\Model
{
/**
* API version used to start the operation.
*
* @var string
*/
public $apiVersion;
/**
* The time the operation was created.
*
* @var string
*/
public $createTime;
/**
* The time the operation finished running.
*
* @var string
*/
public $endTime;
/**
* API endpoint name of this operation.
*
* @var string
*/
public $endpoint;
/**
* Identifies whether the user has requested cancellation of the operation.
* Operations that have successfully been cancelled have
* google.longrunning.Operation.error value with a google.rpc.Status.code of
* `1`, corresponding to `Code.CANCELLED`.
*
* @var bool
*/
public $requestedCancellation;
/**
* Human-readable status of the operation, if any.
*
* @var string
*/
public $statusMessage;
/**
* Server-defined resource path for the target of the operation.
*
* @var string
*/
public $target;
/**
* Name of the verb executed by the operation.
*
* @var string
*/
public $verb;
/**
* API version used to start the operation.
*
* @param string $apiVersion
*/
public function setApiVersion($apiVersion)
{
$this->apiVersion = $apiVersion;
}
/**
* @return string
*/
public function getApiVersion()
{
return $this->apiVersion;
}
/**
* The time the operation was created.
*
* @param string $createTime
*/
public function setCreateTime($createTime)
{
$this->createTime = $createTime;
}
/**
* @return string
*/
public function getCreateTime()
{
return $this->createTime;
}
/**
* The time the operation finished running.
*
* @param string $endTime
*/
public function setEndTime($endTime)
{
$this->endTime = $endTime;
}
/**
* @return string
*/
public function getEndTime()
{
return $this->endTime;
}
/**
* API endpoint name of this operation.
*
* @param string $endpoint
*/
public function setEndpoint($endpoint)
{
$this->endpoint = $endpoint;
}
/**
* @return string
*/
public function getEndpoint()
{
return $this->endpoint;
}
/**
* Identifies whether the user has requested cancellation of the operation.
* Operations that have successfully been cancelled have
* google.longrunning.Operation.error value with a google.rpc.Status.code of
* `1`, corresponding to `Code.CANCELLED`.
*
* @param bool $requestedCancellation
*/
public function setRequestedCancellation($requestedCancellation)
{
$this->requestedCancellation = $requestedCancellation;
}
/**
* @return bool
*/
public function getRequestedCancellation()
{
return $this->requestedCancellation;
}
/**
* Human-readable status of the operation, if any.
*
* @param string $statusMessage
*/
public function setStatusMessage($statusMessage)
{
$this->statusMessage = $statusMessage;
}
/**
* @return string
*/
public function getStatusMessage()
{
return $this->statusMessage;
}
/**
* Server-defined resource path for the target of the operation.
*
* @param string $target
*/
public function setTarget($target)
{
$this->target = $target;
}
/**
* @return string
*/
public function getTarget()
{
return $this->target;
}
/**
* Name of the verb executed by the operation.
*
* @param string $verb
*/
public function setVerb($verb)
{
$this->verb = $verb;
}
/**
* @return string
*/
public function getVerb()
{
return $this->verb;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(OperationMetadata::class, 'Google_Service_AIPlatformNotebooks_OperationMetadata');

View File

@@ -1,147 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class Policy extends \Google\Collection
{
protected $collection_key = 'bindings';
protected $bindingsType = Binding::class;
protected $bindingsDataType = 'array';
/**
* `etag` is used for optimistic concurrency control as a way to help prevent
* simultaneous updates of a policy from overwriting each other. It is
* strongly suggested that systems make use of the `etag` in the read-modify-
* write cycle to perform policy updates in order to avoid race conditions: An
* `etag` is returned in the response to `getIamPolicy`, and systems are
* expected to put that etag in the request to `setIamPolicy` to ensure that
* their change will be applied to the same version of the policy.
* **Important:** If you use IAM Conditions, you must include the `etag` field
* whenever you call `setIamPolicy`. If you omit this field, then IAM allows
* you to overwrite a version `3` policy with a version `1` policy, and all of
* the conditions in the version `3` policy are lost.
*
* @var string
*/
public $etag;
/**
* Specifies the format of the policy. Valid values are `0`, `1`, and `3`.
* Requests that specify an invalid value are rejected. Any operation that
* affects conditional role bindings must specify version `3`. This
* requirement applies to the following operations: * Getting a policy that
* includes a conditional role binding * Adding a conditional role binding to
* a policy * Changing a conditional role binding in a policy * Removing any
* role binding, with or without a condition, from a policy that includes
* conditions **Important:** If you use IAM Conditions, you must include the
* `etag` field whenever you call `setIamPolicy`. If you omit this field, then
* IAM allows you to overwrite a version `3` policy with a version `1` policy,
* and all of the conditions in the version `3` policy are lost. If a policy
* does not include any conditions, operations on that policy may specify any
* valid version or leave the field unset. To learn which resources support
* conditions in their IAM policies, see the [IAM
* documentation](https://cloud.google.com/iam/help/conditions/resource-
* policies).
*
* @var int
*/
public $version;
/**
* Associates a list of `members`, or principals, with a `role`. Optionally,
* may specify a `condition` that determines how and when the `bindings` are
* applied. Each of the `bindings` must contain at least one principal. The
* `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of
* these principals can be Google groups. Each occurrence of a principal
* counts towards these limits. For example, if the `bindings` grant 50
* different roles to `user:alice@example.com`, and not to any other
* principal, then you can add another 1,450 principals to the `bindings` in
* the `Policy`.
*
* @param Binding[] $bindings
*/
public function setBindings($bindings)
{
$this->bindings = $bindings;
}
/**
* @return Binding[]
*/
public function getBindings()
{
return $this->bindings;
}
/**
* `etag` is used for optimistic concurrency control as a way to help prevent
* simultaneous updates of a policy from overwriting each other. It is
* strongly suggested that systems make use of the `etag` in the read-modify-
* write cycle to perform policy updates in order to avoid race conditions: An
* `etag` is returned in the response to `getIamPolicy`, and systems are
* expected to put that etag in the request to `setIamPolicy` to ensure that
* their change will be applied to the same version of the policy.
* **Important:** If you use IAM Conditions, you must include the `etag` field
* whenever you call `setIamPolicy`. If you omit this field, then IAM allows
* you to overwrite a version `3` policy with a version `1` policy, and all of
* the conditions in the version `3` policy are lost.
*
* @param string $etag
*/
public function setEtag($etag)
{
$this->etag = $etag;
}
/**
* @return string
*/
public function getEtag()
{
return $this->etag;
}
/**
* Specifies the format of the policy. Valid values are `0`, `1`, and `3`.
* Requests that specify an invalid value are rejected. Any operation that
* affects conditional role bindings must specify version `3`. This
* requirement applies to the following operations: * Getting a policy that
* includes a conditional role binding * Adding a conditional role binding to
* a policy * Changing a conditional role binding in a policy * Removing any
* role binding, with or without a condition, from a policy that includes
* conditions **Important:** If you use IAM Conditions, you must include the
* `etag` field whenever you call `setIamPolicy`. If you omit this field, then
* IAM allows you to overwrite a version `3` policy with a version `1` policy,
* and all of the conditions in the version `3` policy are lost. If a policy
* does not include any conditions, operations on that policy may specify any
* valid version or leave the field unset. To learn which resources support
* conditions in their IAM policies, see the [IAM
* documentation](https://cloud.google.com/iam/help/conditions/resource-
* policies).
*
* @param int $version
*/
public function setVersion($version)
{
$this->version = $version;
}
/**
* @return int
*/
public function getVersion()
{
return $this->version;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Policy::class, 'Google_Service_AIPlatformNotebooks_Policy');

View File

@@ -1,44 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class RefreshRuntimeTokenInternalRequest extends \Google\Model
{
/**
* @var string
*/
public $vmId;
/**
* @param string
*/
public function setVmId($vmId)
{
$this->vmId = $vmId;
}
/**
* @return string
*/
public function getVmId()
{
return $this->vmId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(RefreshRuntimeTokenInternalRequest::class, 'Google_Service_AIPlatformNotebooks_RefreshRuntimeTokenInternalRequest');

View File

@@ -1,62 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class RefreshRuntimeTokenInternalResponse extends \Google\Model
{
/**
* @var string
*/
public $accessToken;
/**
* @var string
*/
public $expireTime;
/**
* @param string
*/
public function setAccessToken($accessToken)
{
$this->accessToken = $accessToken;
}
/**
* @return string
*/
public function getAccessToken()
{
return $this->accessToken;
}
/**
* @param string
*/
public function setExpireTime($expireTime)
{
$this->expireTime = $expireTime;
}
/**
* @return string
*/
public function getExpireTime()
{
return $this->expireTime;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(RefreshRuntimeTokenInternalResponse::class, 'Google_Service_AIPlatformNotebooks_RefreshRuntimeTokenInternalResponse');

View File

@@ -1,44 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class RegisterInstanceRequest extends \Google\Model
{
/**
* @var string
*/
public $instanceId;
/**
* @param string
*/
public function setInstanceId($instanceId)
{
$this->instanceId = $instanceId;
}
/**
* @return string
*/
public function getInstanceId()
{
return $this->instanceId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(RegisterInstanceRequest::class, 'Google_Service_AIPlatformNotebooks_RegisterInstanceRequest');

View File

@@ -1,61 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class ReportInstanceEventRequest extends \Google\Model
{
protected $eventType = Event::class;
protected $eventDataType = '';
public $event;
/**
* @var string
*/
public $vmId;
/**
* @param Event
*/
public function setEvent(Event $event)
{
$this->event = $event;
}
/**
* @return Event
*/
public function getEvent()
{
return $this->event;
}
/**
* @param string
*/
public function setVmId($vmId)
{
$this->vmId = $vmId;
}
/**
* @return string
*/
public function getVmId()
{
return $this->vmId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ReportInstanceEventRequest::class, 'Google_Service_AIPlatformNotebooks_ReportInstanceEventRequest');

View File

@@ -1,62 +0,0 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
namespace Google\Service\AIPlatformNotebooks;
class ReportInstanceInfoRequest extends \Google\Model
{
/**
* @var string[]
*/
public $metadata = [];
/**
* @var string
*/
public $vmId;
/**
* @param string[]
*/
public function setMetadata($metadata)
{
$this->metadata = $metadata;
}
/**
* @return string[]
*/
public function getMetadata()
{
return $this->metadata;
}
/**
* @param string
*/
public function setVmId($vmId)
{
$this->vmId = $vmId;
}
/**
* @return string
*/
public function getVmId()
{
return $this->vmId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ReportInstanceInfoRequest::class, 'Google_Service_AIPlatformNotebooks_ReportInstanceInfoRequest');

Some files were not shown because too many files have changed in this diff Show More