Index
A
- Advice — Class in namespace Google\Api
- Generated advice about this change, used for providing more information about how a change will affect the existing service.
- AuthProvider — Class in namespace Google\Api
- Configuration for an anthentication provider, including support for JSON Web Token (JWT).
- AuthRequirement — Class in namespace Google\Api
- User-defined authentication requirements, including support for JSON Web Token (JWT).
- Authentication — Class in namespace Google\Api
Authentication
defines the authentication configuration for an API.- AuthenticationRule — Class in namespace Google\Api
- Authentication rules for the service.
- $BackendRule#authentication — Property in class BackendRule
- AbstractType — Class in namespace Google\Api\Expr\V1alpha1\Type
- Application defined abstract type.
- AuditConfigDelta — Class in namespace Google\Cloud\Iam\V1
- One delta entry for AuditConfig. Each individual change (only one exempted_member in each entry) to a AuditConfig will be a separate entry.
- Action — Class in namespace Google\Cloud\Iam\V1\AuditConfigDelta
- The type of action performed on an audit configuration in a policy.
- AuditConfigDelta_Action — Class in namespace Google\Cloud\Iam\V1
- This class is deprecated. Use Google\Cloud\Iam\V1\AuditConfigDelta\Action instead.
- Action — Class in namespace Google\Cloud\Iam\V1\BindingDelta
- The type of action performed on a Binding in a policy.
- AuditData — Class in namespace Google\Iam\V1\Logging
- Audit log information specific to Cloud IAM. This message is serialized
as an
Any
type in theServiceData
message of anAuditLog
message.
B
- Backend — Class in namespace Google\Api
Backend
defines the backend configuration for a service.- BackendRule — Class in namespace Google\Api
- A backend rule provides configuration for an individual API element.
- BackendRule_PathTranslation — Class in namespace Google\Api
- This class is deprecated. Use Google\Api\BackendRule\PathTranslation instead.
- Billing — Class in namespace Google\Api
- Billing related configuration of the service.
- BillingDestination — Class in namespace Google\Api\Billing
- Configuration of a specific billing destination (Currently only support bill against consumer project).
- Billing_BillingDestination — Class in namespace Google\Api
- This class is deprecated. Use Google\Api\Billing\BillingDestination instead.
- BucketOptions — Class in namespace Google\Api\Distribution
BucketOptions
describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly.- Binding — Class in namespace Google\Cloud\Iam\V1
- Associates
members
with arole
. - BindingDelta — Class in namespace Google\Cloud\Iam\V1
- One delta entry for Binding. Each individual change (only one member in each entry) to a binding will be a separate entry.
- BindingDelta_Action — Class in namespace Google\Cloud\Iam\V1
- This class is deprecated. Use Google\Cloud\Iam\V1\BindingDelta\Action instead.
- BadRequest — Class in namespace Google\Rpc
- Describes violations in a client request. This error type focuses on the syntactic aspects of the request.
- BadRequest_FieldViolation — Class in namespace Google\Rpc
- This class is deprecated. Use Google\Rpc\BadRequest\FieldViolation instead.
C
- ChangeType — Class in namespace Google\Api
- Classifies set of possible modifications to an object in the service configuration.
- ConfigChange — Class in namespace Google\Api
- Output generated from semantically comparing two versions of a service configuration.
- Context — Class in namespace Google\Api
Context
defines which contexts an API requests.- ContextRule — Class in namespace Google\Api
- A context rule provides information about the context for an individual API element.
- Control — Class in namespace Google\Api
- Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc.
- CustomHttpPattern — Class in namespace Google\Api
- A custom pattern is used for defining custom HTTP verb.
- CheckRequest — Class in namespace Google\Api\Expr\V1alpha1
- Request message for the Check method.
- CheckResponse — Class in namespace Google\Api\Expr\V1alpha1
- Response message for the Check method.
- CheckedExpr — Class in namespace Google\Api\Expr\V1alpha1
- A CEL expression which has been successfully type checked.
- Constant — Class in namespace Google\Api\Expr\V1alpha1
- Represents a primitive literal.
- $Constant#constant_kind — Property in class Constant
- Call — Class in namespace Google\Api\Expr\V1alpha1\Expr
- A call expression, including calls to predefined functions and operators.
- Comprehension — Class in namespace Google\Api\Expr\V1alpha1\Expr
- A comprehension expression applied to a list or map.
- CreateList — Class in namespace Google\Api\Expr\V1alpha1\Expr
- A list creation expression.
- CreateStruct — Class in namespace Google\Api\Expr\V1alpha1\Expr
- A map or message creation expression.
- Call — Class in namespace Google\Api\Expr\V1beta1\Expr
- A call expression, including calls to predefined functions and operators.
- Comprehension — Class in namespace Google\Api\Expr\V1beta1\Expr
- A comprehension expression applied to a list or map.
- CreateList — Class in namespace Google\Api\Expr\V1beta1\Expr
- A list creation expression.
- CreateStruct — Class in namespace Google\Api\Expr\V1beta1\Expr
- A map or message creation expression.
- $Literal#constant_kind — Property in class Literal
- Location::clearMetadata() — Method in class Location
- Code — Class in namespace Google\Rpc
- The canonical error codes for gRPC APIs.
- RetryInfo::clearRetryDelay() — Method in class RetryInfo
- $Status#code — Property in class Status
- The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
- CalendarPeriod — Class in namespace Google\Type
- A
CalendarPeriod
represents the abstract concept of a time period that has a canonical start. Grammatically, "the start of the currentCalendarPeriod
." All calendar times begin at midnight UTC. - Color — Class in namespace Google\Type
- Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness; for example, the fields of this representation can be trivially provided to the constructor of "java.awt.Color" in Java; it can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" method in iOS; and, with just a little work, it can be easily formatted into a CSS "rgba()" string in JavaScript, as well.
- Interval::clearStartTime() — Method in class Interval
- Interval::clearEndTime() — Method in class Interval
D
- Distribution — Class in namespace Google\Api
Distribution
contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets.- Distribution_BucketOptions — Class in namespace Google\Api
- This class is deprecated. Use Google\Api\Distribution\BucketOptions instead.
- Distribution_BucketOptions_Explicit — Class in namespace Google\Api
- This class is deprecated. Use Google\Api\Distribution\BucketOptions\Explicit instead.
- Distribution_BucketOptions_Exponential — Class in namespace Google\Api
- This class is deprecated. Use Google\Api\Distribution\BucketOptions\Exponential instead.
- Distribution_BucketOptions_Linear — Class in namespace Google\Api
- This class is deprecated. Use Google\Api\Distribution\BucketOptions\Linear instead.
- Distribution_Exemplar — Class in namespace Google\Api
- This class is deprecated. Use Google\Api\Distribution\Exemplar instead.
- Distribution_Range — Class in namespace Google\Api
- This class is deprecated. Use Google\Api\Distribution\Range instead.
- Documentation — Class in namespace Google\Api
Documentation
provides the information for describing a service.- DocumentationRule — Class in namespace Google\Api
- A documentation rule provides information about individual API elements.
- Decl — Class in namespace Google\Api\Expr\V1alpha1
- Represents a declaration of a named value or function.
- $Decl#decl_kind — Property in class Decl
- Decl_FunctionDecl — Class in namespace Google\Api\Expr\V1alpha1
- This class is deprecated. Use Google\Api\Expr\V1alpha1\Decl\FunctionDecl instead.
- Decl_FunctionDecl_Overload — Class in namespace Google\Api\Expr\V1alpha1
- This class is deprecated. Use Google\Api\Expr\V1alpha1\Decl\FunctionDecl\Overload instead.
- Decl_IdentDecl — Class in namespace Google\Api\Expr\V1alpha1
- This class is deprecated. Use Google\Api\Expr\V1alpha1\Decl\IdentDecl instead.
- Decl — Class in namespace Google\Api\Expr\V1beta1
- A declaration.
- DeclType — Class in namespace Google\Api\Expr\V1beta1
- The declared type of a variable.
- $Location#display_name — Property in class Location
- The friendly name for this location, typically a nearby city name.
- $FieldViolation#description — Property in class FieldViolation
- A description of why the request element is bad.
- DebugInfo — Class in namespace Google\Rpc
- Describes additional debugging info.
- $DebugInfo#detail — Property in class DebugInfo
- Additional debugging information provided by the server.
- $ErrorInfo#domain — Property in class ErrorInfo
- The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
- $Link#description — Property in class Link
- Describes what the link offers.
- $Violation#description — Property in class Violation
- A description of how the precondition failed. Developers can use this description to understand how to fix the failure.
- $Violation#description — Property in class Violation
- A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.
- $ResourceInfo#description — Property in class ResourceInfo
- Describes what error is encountered when accessing this resource.
- Date — Class in namespace Google\Type
- Represents a whole or partial calendar date, e.g. a birthday. The time of day
and time zone are either specified elsewhere or are not significant. The date
is relative to the Proleptic Gregorian Calendar. This can represent:
* A full date, with non-zero year, month and day values
* A month and day value, with a zero year, e.g. an anniversary
* A year on its own, with zero month and day values
* A year and month value, with a zero day, e.g. a credit card expiration date
Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and
google.protobuf.Timestamp
. - DateTime — Class in namespace Google\Type
- Represents civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC.
- DayOfWeek — Class in namespace Google\Type
- Represents a day of week.
- Decimal — Class in namespace Google\Type
- A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal][] or Python's [decimal.Decimal][].
E
- Explicit — Class in namespace Google\Api\Distribution\BucketOptions
- Specifies a set of buckets with arbitrary widths.
- Exponential — Class in namespace Google\Api\Distribution\BucketOptions
- Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.
- Exemplar — Class in namespace Google\Api\Distribution
- Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.
- Endpoint — Class in namespace Google\Api
Endpoint
describes a network endpoint that serves a set of APIs.- EnumValue — Class in namespace Google\Api\Expr\V1alpha1
- An enum value.
- ErrorSet — Class in namespace Google\Api\Expr\V1alpha1
- A set of errors.
- EvalRequest — Class in namespace Google\Api\Expr\V1alpha1
- Request message for the Eval method.
- $EvalRequest#expr_kind — Property in class EvalRequest
- EvalResponse — Class in namespace Google\Api\Expr\V1alpha1
- Response message for the Eval method.
- EvalState — Class in namespace Google\Api\Expr\V1alpha1
- The state of an evaluation.
- EvalState_Result — Class in namespace Google\Api\Expr\V1alpha1
- This class is deprecated. Use Google\Api\Expr\V1alpha1\EvalState\Result instead.
- Explain — Class in namespace Google\Api\Expr\V1alpha1
- Values of intermediate expressions produced when evaluating expression.
- ExprStep — Class in namespace Google\Api\Expr\V1alpha1\Explain
- ID and value index of one step.
- Explain_ExprStep — Class in namespace Google\Api\Expr\V1alpha1
- This class is deprecated. Use Google\Api\Expr\V1alpha1\Explain\ExprStep instead.
- Expr — Class in namespace Google\Api\Expr\V1alpha1
- An abstract representation of a common expression.
- $Expr#expr_kind — Property in class Expr
- ExprValue — Class in namespace Google\Api\Expr\V1alpha1
- The value of an evaluated expression.
- Entry — Class in namespace Google\Api\Expr\V1alpha1\Expr\CreateStruct
- Represents an entry.
- Expr_Call — Class in namespace Google\Api\Expr\V1alpha1
- This class is deprecated. Use Google\Api\Expr\V1alpha1\Expr\Call instead.
- Expr_Comprehension — Class in namespace Google\Api\Expr\V1alpha1
- This class is deprecated. Use Google\Api\Expr\V1alpha1\Expr\Comprehension instead.
- Expr_CreateList — Class in namespace Google\Api\Expr\V1alpha1
- This class is deprecated. Use Google\Api\Expr\V1alpha1\Expr\CreateList instead.
- Expr_CreateStruct — Class in namespace Google\Api\Expr\V1alpha1
- This class is deprecated. Use Google\Api\Expr\V1alpha1\Expr\CreateStruct instead.
- Expr_CreateStruct_Entry — Class in namespace Google\Api\Expr\V1alpha1
- This class is deprecated. Use Google\Api\Expr\V1alpha1\Expr\CreateStruct\Entry instead.
- Expr_Ident — Class in namespace Google\Api\Expr\V1alpha1
- This class is deprecated. Use Google\Api\Expr\V1alpha1\Expr\Ident instead.
- Expr_Select — Class in namespace Google\Api\Expr\V1alpha1
- This class is deprecated. Use Google\Api\Expr\V1alpha1\Expr\Select instead.
- Entry — Class in namespace Google\Api\Expr\V1alpha1\MapValue
- An entry in the map.
- EnumValue — Class in namespace Google\Api\Expr\V1beta1
- An enum value.
- ErrorSet — Class in namespace Google\Api\Expr\V1beta1
- A set of errors.
- EvalState — Class in namespace Google\Api\Expr\V1beta1
- The state of an evaluation.
- EvalState_Result — Class in namespace Google\Api\Expr\V1beta1
- This class is deprecated. Use Google\Api\Expr\V1beta1\EvalState\Result instead.
- Expr — Class in namespace Google\Api\Expr\V1beta1
- An abstract representation of a common expression.
- $Expr#expr_kind — Property in class Expr
- ExprValue — Class in namespace Google\Api\Expr\V1beta1
- The value of an evaluated expression.
- Entry — Class in namespace Google\Api\Expr\V1beta1\Expr\CreateStruct
- Represents an entry.
- Expr_Call — Class in namespace Google\Api\Expr\V1beta1
- This class is deprecated. Use Google\Api\Expr\V1beta1\Expr\Call instead.
- Expr_Comprehension — Class in namespace Google\Api\Expr\V1beta1
- This class is deprecated. Use Google\Api\Expr\V1beta1\Expr\Comprehension instead.
- Expr_CreateList — Class in namespace Google\Api\Expr\V1beta1
- This class is deprecated. Use Google\Api\Expr\V1beta1\Expr\CreateList instead.
- Expr_CreateStruct — Class in namespace Google\Api\Expr\V1beta1
- This class is deprecated. Use Google\Api\Expr\V1beta1\Expr\CreateStruct instead.
- Expr_CreateStruct_Entry — Class in namespace Google\Api\Expr\V1beta1
- This class is deprecated. Use Google\Api\Expr\V1beta1\Expr\CreateStruct\Entry instead.
- Expr_Ident — Class in namespace Google\Api\Expr\V1beta1
- This class is deprecated. Use Google\Api\Expr\V1beta1\Expr\Ident instead.
- Expr_Select — Class in namespace Google\Api\Expr\V1beta1
- This class is deprecated. Use Google\Api\Expr\V1beta1\Expr\Select instead.
- Entry — Class in namespace Google\Api\Expr\V1beta1\MapValue
- An entry in the map.
- ErrorInfo — Class in namespace Google\Rpc
- Describes the cause of the error with structured details.
- Expr — Class in namespace Google\Type
- Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0"
- $Interval#end_time — Property in class Interval
- Optional. Exclusive end of the interval.
- $PhoneNumber#extension — Property in class PhoneNumber
- The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here.
F
- FunctionDecl — Class in namespace Google\Api\Expr\V1alpha1\Decl
- Function declaration specifies one or more overloads which indicate the function's parameter types and return type, and may optionally specify a function definition in terms of CEL expressions.
- FunctionType — Class in namespace Google\Api\Expr\V1alpha1\Type
- Function type with result and arg types.
- FunctionDecl — Class in namespace Google\Api\Expr\V1beta1
- A function declaration.
- FieldBehavior — Class in namespace Google\Api
- An indicator of the behavior of a given field (for example, that a field is required in requests, or given as output but ignored as input).
- $RoutingParameter#field — Property in class RoutingParameter
- A request field to extract the header key-value pair from.
- $ListLocationsRequest#filter — Property in class ListLocationsRequest
- The standard list filter.
- FieldViolation — Class in namespace Google\Rpc\BadRequest
- A message type used to describe a single bad request field.
- $FieldViolation#field — Property in class FieldViolation
- A path leading to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field. E.g., "field_violations.field" would identify this field.
- Fraction — Class in namespace Google\Type
- Represents a fraction in terms of a numerator divided by a denominator.
G
- Advice::getDescription() — Method in class Advice
- Useful description for why this advice was applied and what actions should be taken to mitigate any implied risks.
- AuthProvider::getId() — Method in class AuthProvider
- The unique identifier of the auth provider. It will be referred to by
AuthRequirement.provider_id
. - AuthProvider::getIssuer() — Method in class AuthProvider
- Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address.
- AuthProvider::getJwksUri() — Method in class AuthProvider
- URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery.
- AuthProvider::getAudiences() — Method in class AuthProvider
- The list of JWT audiences.
- AuthProvider::getAuthorizationUrl() — Method in class AuthProvider
- Redirect URL if JWT token is required but no present or is expired.
- AuthRequirement::getProviderId() — Method in class AuthRequirement
- [id][google.api.AuthProvider.id] from authentication provider.
- AuthRequirement::getAudiences() — Method in class AuthRequirement
- NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components.
- Authentication::getRules() — Method in class Authentication
- A list of authentication rules that apply to individual API methods.
- Authentication::getProviders() — Method in class Authentication
- Defines a set of authentication providers that a service supports.
- AuthenticationRule::getSelector() — Method in class AuthenticationRule
- Selects the methods to which this rule applies.
- AuthenticationRule::getOauth() — Method in class AuthenticationRule
- The requirements for OAuth credentials.
- AuthenticationRule::getAllowWithoutCredential() — Method in class AuthenticationRule
- If true, the service accepts API keys without any other credential.
- AuthenticationRule::getRequirements() — Method in class AuthenticationRule
- Requirements for additional authentication providers.
- Backend::getRules() — Method in class Backend
- A list of API backend rules that apply to individual API methods.
- BackendRule::getSelector() — Method in class BackendRule
- Selects the methods to which this rule applies.
- BackendRule::getAddress() — Method in class BackendRule
- The address of the API backend.
- BackendRule::getDeadline() — Method in class BackendRule
- The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
- BackendRule::getMinDeadline() — Method in class BackendRule
- Minimum deadline in seconds needed for this method. Calls having deadline value lower than this will be rejected.
- BackendRule::getOperationDeadline() — Method in class BackendRule
- The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- BackendRule::getPathTranslation() — Method in class BackendRule
- Generated from protobuf field
.google.api.BackendRule.PathTranslation path_translation = 6;
- BackendRule::getJwtAudience() — Method in class BackendRule
- The JWT audience is used when generating a JWT ID token for the backend.
- BackendRule::getDisableAuth() — Method in class BackendRule
- When disable_auth is false, a JWT ID token will be generated with the value from [BackendRule.address][google.api.BackendRule.address] as jwt_audience, overrode to the HTTP "Authorization" request header and sent to the backend.
- BackendRule::getAuthentication() — Method in class BackendRule
- Billing::getConsumerDestinations() — Method in class Billing
- Billing configurations for sending metrics to the consumer project.
- BillingDestination::getMonitoredResource() — Method in class BillingDestination
- The monitored resource type. The type must be defined in [Service.monitored_resources][google.api.Service.monitored_resources] section.
- BillingDestination::getMetrics() — Method in class BillingDestination
- Names of the metrics to report to this billing destination.
- ConfigChange::getElement() — Method in class ConfigChange
- Object hierarchy path to the change, with levels separated by a '.' character. For repeated fields, an applicable unique identifier field is used for the index (usually selector, name, or id). For maps, the term 'key' is used. If the field has no unique identifier, the numeric index is used.
- ConfigChange::getOldValue() — Method in class ConfigChange
- Value of the changed object in the old Service configuration, in JSON format. This field will not be populated if ChangeType == ADDED.
- ConfigChange::getNewValue() — Method in class ConfigChange
- Value of the changed object in the new Service configuration, in JSON format. This field will not be populated if ChangeType == REMOVED.
- ConfigChange::getChangeType() — Method in class ConfigChange
- The type for this change, either ADDED, REMOVED, or MODIFIED.
- ConfigChange::getAdvices() — Method in class ConfigChange
- Collection of advice provided for this change, useful for determining the possible impact of this change.
- Context::getRules() — Method in class Context
- A list of RPC context rules that apply to individual API methods.
- ContextRule::getSelector() — Method in class ContextRule
- Selects the methods to which this rule applies.
- ContextRule::getRequested() — Method in class ContextRule
- A list of full type names of requested contexts.
- ContextRule::getProvided() — Method in class ContextRule
- A list of full type names of provided contexts.
- Control::getEnvironment() — Method in class Control
- The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled.
- CustomHttpPattern::getKind() — Method in class CustomHttpPattern
- The name of this custom HTTP verb.
- CustomHttpPattern::getPath() — Method in class CustomHttpPattern
- The path matched by this custom verb.
- Distribution::getCount() — Method in class Distribution
- The number of values in the population. Must be non-negative. This value
must equal the sum of the values in
bucket_counts
if a histogram is provided. - Distribution::getMean() — Method in class Distribution
- The arithmetic mean of the values in the population. If
count
is zero then this field must be zero. - Distribution::getSumOfSquaredDeviation() — Method in class Distribution
- The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1.
- Distribution::getRange() — Method in class Distribution
- If specified, contains the range of the population values. The field
must not be present if the
count
is zero. - Distribution::getBucketOptions() — Method in class Distribution
- Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field.
- Distribution::getBucketCounts() — Method in class Distribution
- The number of values in each bucket of the histogram, as described in
bucket_options
. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values inbucket_counts
must equal the value in thecount
field of the distribution. - Distribution::getExemplars() — Method in class Distribution
- Must be in increasing order of
value
field. - BucketOptions::getLinearBuckets() — Method in class BucketOptions
- The linear bucket.
- BucketOptions::getExponentialBuckets() — Method in class BucketOptions
- The exponential buckets.
- BucketOptions::getExplicitBuckets() — Method in class BucketOptions
- The explicit buckets.
- BucketOptions::getOptions() — Method in class BucketOptions
- Explicit::getBounds() — Method in class Explicit
- The values must be monotonically increasing.
- Exponential::getNumFiniteBuckets() — Method in class Exponential
- Must be greater than 0.
- Exponential::getGrowthFactor() — Method in class Exponential
- Must be greater than 1.
- Exponential::getScale() — Method in class Exponential
- Must be greater than 0.
- Linear::getNumFiniteBuckets() — Method in class Linear
- Must be greater than 0.
- Linear::getWidth() — Method in class Linear
- Must be greater than 0.
- Linear::getOffset() — Method in class Linear
- Lower bound of the first bucket.
- Exemplar::getValue() — Method in class Exemplar
- Value of the exemplar point. This value determines to which bucket the exemplar belongs.
- Exemplar::getTimestamp() — Method in class Exemplar
- The observation (sampling) time of the above value.
- Exemplar::getAttachments() — Method in class Exemplar
- Contextual information about the example value. Examples are: Trace ID: type.googleapis.com/google.devtools.cloudtrace.v1.Trace Literal string: type.googleapis.com/google.protobuf.StringValue Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.
- Range::getMin() — Method in class Range
- The minimum of the population values.
- Range::getMax() — Method in class Range
- The maximum of the population values.
- Documentation::getSummary() — Method in class Documentation
- A short summary of what the service does. Can only be provided by plain text.
- Documentation::getPages() — Method in class Documentation
- The top level pages for the documentation set.
- Documentation::getRules() — Method in class Documentation
- A list of documentation rules that apply to individual API elements.
- Documentation::getDocumentationRootUrl() — Method in class Documentation
- The URL to the root of documentation.
- Documentation::getOverview() — Method in class Documentation
- Declares a single overview page. For example:
<
pre>
documentation: summary: .
- DocumentationRule::getSelector() — Method in class DocumentationRule
- The selector is a comma-separated list of patterns. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard.
- DocumentationRule::getDescription() — Method in class DocumentationRule
- Description of the selected API(s).
- DocumentationRule::getDeprecationDescription() — Method in class DocumentationRule
- Deprecation description of the selected element(s). It can be provided if an
element is marked as
deprecated
. - Endpoint::getName() — Method in class Endpoint
- The canonical name of this endpoint.
- Endpoint::getAliases() — Method in class Endpoint
- DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple [google.api.Endpoint][google.api.Endpoint] for each of the intended aliases.
- Endpoint::getFeatures() — Method in class Endpoint
- The list of features enabled on this endpoint.
- Endpoint::getTarget() — Method in class Endpoint
- The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint.
- Endpoint::getAllowCors() — Method in class Endpoint
- Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.
- CheckRequest::getParsedExpr() — Method in class CheckRequest
- Required. The parsed representation of the CEL program.
- CheckRequest::getTypeEnv() — Method in class CheckRequest
- Declarations of types for external variables and functions.
- CheckRequest::getContainer() — Method in class CheckRequest
- The protocol buffer context. See "Name Resolution" in the Language Definition.
- CheckRequest::getNoStdEnv() — Method in class CheckRequest
- If true, use only the declarations in [type_env][google.api.expr.v1alpha1.CheckRequest.type_env]. If false (default), add declarations for the standard definitions to the type environment. See "Standard Definitions" in the Language Definition.
- CheckResponse::getCheckedExpr() — Method in class CheckResponse
- The annotated representation, or unset if checking failed.
- CheckResponse::getIssues() — Method in class CheckResponse
- Any number of issues with [StatusDetails][] as the details.
- CheckedExpr::getReferenceMap() — Method in class CheckedExpr
- A map from expression ids to resolved references.
- CheckedExpr::getTypeMap() — Method in class CheckedExpr
- A map from expression ids to types.
- CheckedExpr::getSourceInfo() — Method in class CheckedExpr
- The source info derived from input that generated the parsed
expr
and any optimizations made during the type-checking pass. - CheckedExpr::getExpr() — Method in class CheckedExpr
- The checked expression. Semantically equivalent to the parsed
expr
, but may have structural differences. - Constant::getNullValue() — Method in class Constant
- null value.
- Constant::getBoolValue() — Method in class Constant
- boolean value.
- Constant::getInt64Value() — Method in class Constant
- int64 value.
- Constant::getUint64Value() — Method in class Constant
- uint64 value.
- Constant::getDoubleValue() — Method in class Constant
- double value.
- Constant::getStringValue() — Method in class Constant
- string value.
- Constant::getBytesValue() — Method in class Constant
- bytes value.
- Constant::getDurationValue() — Method in class Constant
- protobuf.Duration value.
- Constant::getTimestampValue() — Method in class Constant
- protobuf.Timestamp value.
- Constant::getConstantKind() — Method in class Constant
- Decl::getName() — Method in class Decl
- The fully qualified name of the declaration.
- Decl::getIdent() — Method in class Decl
- Identifier declaration.
- Decl::getFunction() — Method in class Decl
- Function declaration.
- Decl::getDeclKind() — Method in class Decl
- FunctionDecl::getOverloads() — Method in class FunctionDecl
- Required. List of function overloads, must contain at least one overload.
- Overload::getOverloadId() — Method in class Overload
- Required. Globally unique overload name of the function which reflects the function name and argument types.
- Overload::getParams() — Method in class Overload
- List of function parameter [Type][google.api.expr.v1alpha1.Type] values.
- Overload::getTypeParams() — Method in class Overload
- The type param names associated with the function declaration.
- Overload::getResultType() — Method in class Overload
- Required. The result type of the function. For example, the operator
string.isEmpty()
would haveresult_type
ofkind: BOOL
. - Overload::getIsInstanceFunction() — Method in class Overload
- Whether the function is to be used in a method call-style `x.f(.
- Overload::getDoc() — Method in class Overload
- Documentation string for the overload.
- IdentDecl::getType() — Method in class IdentDecl
- Required. The type of the identifier.
- IdentDecl::getValue() — Method in class IdentDecl
- The constant value of the identifier. If not specified, the identifier must be supplied at evaluation time.
- IdentDecl::getDoc() — Method in class IdentDecl
- Documentation string for the identifier.
- EnumValue::getType() — Method in class EnumValue
- The fully qualified name of the enum type.
- EnumValue::getValue() — Method in class EnumValue
- The value of the enum.
- ErrorSet::getErrors() — Method in class ErrorSet
- The errors in the set.
- EvalRequest::getParsedExpr() — Method in class EvalRequest
- Evaluate based on the parsed representation.
- EvalRequest::getCheckedExpr() — Method in class EvalRequest
- Evaluate based on the checked representation.
- EvalRequest::getBindings() — Method in class EvalRequest
- Bindings for the external variables. The types SHOULD be compatible with the type environment in [CheckRequest][google.api.expr.v1alpha1.CheckRequest], if checked.
- EvalRequest::getContainer() — Method in class EvalRequest
- SHOULD be the same container as used in [CheckRequest][google.api.expr.v1alpha1.CheckRequest], if checked.
- EvalRequest::getExprKind() — Method in class EvalRequest
- EvalResponse::getResult() — Method in class EvalResponse
- The execution result, or unset if execution couldn't start.
- EvalResponse::getIssues() — Method in class EvalResponse
- Any number of issues with [StatusDetails][] as the details.
- EvalState::getValues() — Method in class EvalState
- The unique values referenced in this message.
- EvalState::getResults() — Method in class EvalState
- An ordered list of results.
- Result::getExpr() — Method in class Result
- The id of the expression this result if for.
- Result::getValue() — Method in class Result
- The index in
values
of the resulting value. - Explain::getValues() — Method in class Explain
- All of the observed values.
- Explain::getExprSteps() — Method in class Explain
- List of steps.
- ExprStep::getId() — Method in class ExprStep
- ID of corresponding Expr node.
- ExprStep::getValueIndex() — Method in class ExprStep
- Index of the value in the values list.
- Expr::getId() — Method in class Expr
- Required. An id assigned to this node by the parser which is unique in a given expression tree. This is used to associate type information and other attributes to a node in the parse tree.
- Expr::getConstExpr() — Method in class Expr
- A literal expression.
- Expr::getIdentExpr() — Method in class Expr
- An identifier expression.
- Expr::getSelectExpr() — Method in class Expr
- A field selection expression, e.g.
request.auth
. - Expr::getCallExpr() — Method in class Expr
- A call expression, including calls to predefined functions and operators.
- Expr::getListExpr() — Method in class Expr
- A list creation expression.
- Expr::getStructExpr() — Method in class Expr
- A map or message creation expression.
- Expr::getComprehensionExpr() — Method in class Expr
- A comprehension expression.
- Expr::getExprKind() — Method in class Expr
- ExprValue::getValue() — Method in class ExprValue
- A concrete value.
- ExprValue::getError() — Method in class ExprValue
- The set of errors in the critical path of evalution.
- ExprValue::getUnknown() — Method in class ExprValue
- The set of unknowns in the critical path of evaluation.
- ExprValue::getKind() — Method in class ExprValue
- Call::getTarget() — Method in class Call
- The target of an method call-style expression. For example,
x
inx.f()
. - Call::getFunction() — Method in class Call
- Required. The name of the function or method being called.
- Call::getArgs() — Method in class Call
- The arguments.
- Comprehension::getIterVar() — Method in class Comprehension
- The name of the iteration variable.
- Comprehension::getIterRange() — Method in class Comprehension
- The range over which var iterates.
- Comprehension::getAccuVar() — Method in class Comprehension
- The name of the variable used for accumulation of the result.
- Comprehension::getAccuInit() — Method in class Comprehension
- The initial value of the accumulator.
- Comprehension::getLoopCondition() — Method in class Comprehension
- An expression which can contain iter_var and accu_var.
- Comprehension::getLoopStep() — Method in class Comprehension
- An expression which can contain iter_var and accu_var.
- Comprehension::getResult() — Method in class Comprehension
- An expression which can contain accu_var.
- CreateList::getElements() — Method in class CreateList
- The elements part of the list.
- CreateStruct::getMessageName() — Method in class CreateStruct
- The type name of the message to be created, empty when creating map literals.
- CreateStruct::getEntries() — Method in class CreateStruct
- The entries in the creation expression.
- Entry::getId() — Method in class Entry
- Required. An id assigned to this node by the parser which is unique in a given expression tree. This is used to associate type information and other attributes to the node.
- Entry::getFieldKey() — Method in class Entry
- The field key for a message creator statement.
- Entry::getMapKey() — Method in class Entry
- The key expression for a map creation statement.
- Entry::getValue() — Method in class Entry
- Required. The value assigned to the key.
- Entry::getKeyKind() — Method in class Entry
- Ident::getName() — Method in class Ident
- Required. Holds a single, unqualified identifier, possibly preceded by a '.'.
- Select::getOperand() — Method in class Select
- Required. The target of the selection expression.
- Select::getField() — Method in class Select
- Required. The name of the field to select.
- Select::getTestOnly() — Method in class Select
- Whether the select is to be interpreted as a field presence test.
- IssueDetails::getSeverity() — Method in class IssueDetails
- The severity of the issue.
- IssueDetails::getPosition() — Method in class IssueDetails
- Position in the source, if known.
- IssueDetails::getId() — Method in class IssueDetails
- Expression ID from [Expr][google.api.expr.v1alpha1.Expr], 0 if unknown.
- ListValue::getValues() — Method in class ListValue
- The ordered values in the list.
- MapValue::getEntries() — Method in class MapValue
- The set of map entries.
- Entry::getKey() — Method in class Entry
- The key.
- Entry::getValue() — Method in class Entry
- The value.
- ParseRequest::getCelSource() — Method in class ParseRequest
- Required. Source text in CEL syntax.
- ParseRequest::getSyntaxVersion() — Method in class ParseRequest
- Tag for version of CEL syntax, for future use.
- ParseRequest::getSourceLocation() — Method in class ParseRequest
- File or resource for source text, used in [SourceInfo][google.api.expr.v1alpha1.SourceInfo].
- ParseRequest::getDisableMacros() — Method in class ParseRequest
- Prevent macro expansion. See "Macros" in Language Defiinition.
- ParseResponse::getParsedExpr() — Method in class ParseResponse
- The parsed representation, or unset if parsing failed.
- ParseResponse::getIssues() — Method in class ParseResponse
- Any number of issues with [StatusDetails][] as the details.
- ParsedExpr::getExpr() — Method in class ParsedExpr
- The parsed expression.
- ParsedExpr::getSourceInfo() — Method in class ParsedExpr
- The source info derived from input that generated the parsed
expr
. - Reference::getName() — Method in class Reference
- The fully qualified name of the declaration.
- Reference::getOverloadId() — Method in class Reference
- For references to functions, this is a list of
Overload.overload_id
values which match according to typing rules. - Reference::getValue() — Method in class Reference
- For references to constants, this may contain the value of the constant if known at compile time.
- SourceInfo::getSyntaxVersion() — Method in class SourceInfo
- The syntax version of the source, e.g.
cel1
. - SourceInfo::getLocation() — Method in class SourceInfo
- The location name. All position information attached to an expression is relative to this location.
- SourceInfo::getLineOffsets() — Method in class SourceInfo
- Monotonically increasing list of character offsets where newlines appear.
- SourceInfo::getPositions() — Method in class SourceInfo
- A map from the parse node id (e.g.
Expr.id
) to the character offset within source. - SourceInfo::getMacroCalls() — Method in class SourceInfo
- A map from the parse node id where a macro replacement was made to the
call
Expr
that resulted in a macro expansion. - SourcePosition::getLocation() — Method in class SourcePosition
- The soucre location name (e.g. file name).
- SourcePosition::getOffset() — Method in class SourcePosition
- The character offset.
- SourcePosition::getLine() — Method in class SourcePosition
- The 1-based index of the starting line in the source text where the issue occurs, or 0 if unknown.
- SourcePosition::getColumn() — Method in class SourcePosition
- The 0-based index of the starting position within the line of source text where the issue occurs. Only meaningful if line is nonzero.
- Type::getDyn() — Method in class Type
- Dynamic type.
- Type::getNull() — Method in class Type
- Null value.
- Type::getPrimitive() — Method in class Type
- Primitive types:
true
,1u
,-2.0
,'string'
,b'bytes'
. - Type::getWrapper() — Method in class Type
- Wrapper of a primitive type, e.g.
google.protobuf.Int64Value
. - Type::getWellKnown() — Method in class Type
- Well-known protobuf type such as
google.protobuf.Timestamp
. - Type::getListType() — Method in class Type
- Parameterized list with elements of
list_type
, e.g.list<timestamp>
. - Type::getMapType() — Method in class Type
- Parameterized map with typed keys and values.
- Type::getFunction() — Method in class Type
- Function type.
- Type::getMessageType() — Method in class Type
- Protocol buffer message type.
- Type::getTypeParam() — Method in class Type
- Type param type.
- Type::getType() — Method in class Type
- Type type.
- Type::getError() — Method in class Type
- Error type.
- Type::getAbstractType() — Method in class Type
- Abstract, application defined type.
- Type::getTypeKind() — Method in class Type
- AbstractType::getName() — Method in class AbstractType
- The fully qualified name of this abstract type.
- AbstractType::getParameterTypes() — Method in class AbstractType
- Parameter types for this abstract type.
- FunctionType::getResultType() — Method in class FunctionType
- Result type of the function.
- FunctionType::getArgTypes() — Method in class FunctionType
- Argument types of the function.
- ListType::getElemType() — Method in class ListType
- The element type.
- MapType::getKeyType() — Method in class MapType
- The type of the key.
- MapType::getValueType() — Method in class MapType
- The type of the value.
- UnknownSet::getExprs() — Method in class UnknownSet
- The ids of the expressions with unknown values.
- Value::getNullValue() — Method in class Value
- Null value.
- Value::getBoolValue() — Method in class Value
- Boolean value.
- Value::getInt64Value() — Method in class Value
- Signed integer value.
- Value::getUint64Value() — Method in class Value
- Unsigned integer value.
- Value::getDoubleValue() — Method in class Value
- Floating point value.
- Value::getStringValue() — Method in class Value
- UTF-8 string value.
- Value::getBytesValue() — Method in class Value
- Byte string value.
- Value::getEnumValue() — Method in class Value
- An enum value.
- Value::getObjectValue() — Method in class Value
- The proto message backing an object value.
- Value::getMapValue() — Method in class Value
- Map value.
- Value::getListValue() — Method in class Value
- List value.
- Value::getTypeValue() — Method in class Value
- Type value.
- Value::getKind() — Method in class Value
- Decl::getId() — Method in class Decl
- The id of the declaration.
- Decl::getName() — Method in class Decl
- The name of the declaration.
- Decl::getDoc() — Method in class Decl
- The documentation string for the declaration.
- Decl::getIdent() — Method in class Decl
- An identifier declaration.
- Decl::getFunction() — Method in class Decl
- A function declaration.
- Decl::getKind() — Method in class Decl
- DeclType::getId() — Method in class DeclType
- The expression id of the declared type, if applicable.
- DeclType::getType() — Method in class DeclType
- The type name, e.g. 'int', 'my.type.Type' or 'T'
- DeclType::getTypeParams() — Method in class DeclType
- An ordered list of type parameters, e.g.
<string, int>
. - EnumValue::getType() — Method in class EnumValue
- The fully qualified name of the enum type.
- EnumValue::getValue() — Method in class EnumValue
- The value of the enum.
- ErrorSet::getErrors() — Method in class ErrorSet
- The errors in the set.
- EvalState::getValues() — Method in class EvalState
- The unique values referenced in this message.
- EvalState::getResults() — Method in class EvalState
- An ordered list of results.
- Result::getExpr() — Method in class Result
- The expression this result is for.
- Result::getValue() — Method in class Result
- The index in
values
of the resulting value. - Expr::getId() — Method in class Expr
- Required. An id assigned to this node by the parser which is unique in a given expression tree. This is used to associate type information and other attributes to a node in the parse tree.
- Expr::getLiteralExpr() — Method in class Expr
- A literal expression.
- Expr::getIdentExpr() — Method in class Expr
- An identifier expression.
- Expr::getSelectExpr() — Method in class Expr
- A field selection expression, e.g.
request.auth
. - Expr::getCallExpr() — Method in class Expr
- A call expression, including calls to predefined functions and operators.
- Expr::getListExpr() — Method in class Expr
- A list creation expression.
- Expr::getStructExpr() — Method in class Expr
- A map or object creation expression.
- Expr::getComprehensionExpr() — Method in class Expr
- A comprehension expression.
- Expr::getExprKind() — Method in class Expr
- ExprValue::getValue() — Method in class ExprValue
- A concrete value.
- ExprValue::getError() — Method in class ExprValue
- The set of errors in the critical path of evalution.
- ExprValue::getUnknown() — Method in class ExprValue
- The set of unknowns in the critical path of evaluation.
- ExprValue::getKind() — Method in class ExprValue
- Call::getTarget() — Method in class Call
- The target of an method call-style expression. For example,
x
inx.f()
. - Call::getFunction() — Method in class Call
- Required. The name of the function or method being called.
- Call::getArgs() — Method in class Call
- The arguments.
- Comprehension::getIterVar() — Method in class Comprehension
- The name of the iteration variable.
- Comprehension::getIterRange() — Method in class Comprehension
- The range over which var iterates.
- Comprehension::getAccuVar() — Method in class Comprehension
- The name of the variable used for accumulation of the result.
- Comprehension::getAccuInit() — Method in class Comprehension
- The initial value of the accumulator.
- Comprehension::getLoopCondition() — Method in class Comprehension
- An expression which can contain iter_var and accu_var.
- Comprehension::getLoopStep() — Method in class Comprehension
- An expression which can contain iter_var and accu_var.
- Comprehension::getResult() — Method in class Comprehension
- An expression which can contain accu_var.
- CreateList::getElements() — Method in class CreateList
- The elements part of the list.
- CreateStruct::getType() — Method in class CreateStruct
- The type name of the message to be created, empty when creating map literals.
- CreateStruct::getEntries() — Method in class CreateStruct
- The entries in the creation expression.
- Entry::getId() — Method in class Entry
- Required. An id assigned to this node by the parser which is unique in a given expression tree. This is used to associate type information and other attributes to the node.
- Entry::getFieldKey() — Method in class Entry
- The field key for a message creator statement.
- Entry::getMapKey() — Method in class Entry
- The key expression for a map creation statement.
- Entry::getValue() — Method in class Entry
- Required. The value assigned to the key.
- Entry::getKeyKind() — Method in class Entry
- Ident::getName() — Method in class Ident
- Required. Holds a single, unqualified identifier, possibly preceded by a '.'.
- Select::getOperand() — Method in class Select
- Required. The target of the selection expression.
- Select::getField() — Method in class Select
- Required. The name of the field to select.
- Select::getTestOnly() — Method in class Select
- Whether the select is to be interpreted as a field presence test.
- FunctionDecl::getArgs() — Method in class FunctionDecl
- The function arguments.
- FunctionDecl::getReturnType() — Method in class FunctionDecl
- Optional declared return type.
- FunctionDecl::getReceiverFunction() — Method in class FunctionDecl
- If the first argument of the function is the receiver.
- IdRef::getId() — Method in class IdRef
- The expression id.
- IdentDecl::getType() — Method in class IdentDecl
- Optional type of the identifier.
- IdentDecl::getValue() — Method in class IdentDecl
- Optional value of the identifier.
- ListValue::getValues() — Method in class ListValue
- The ordered values in the list.
- Literal::getNullValue() — Method in class Literal
- null value.
- Literal::getBoolValue() — Method in class Literal
- boolean value.
- Literal::getInt64Value() — Method in class Literal
- int64 value.
- Literal::getUint64Value() — Method in class Literal
- uint64 value.
- Literal::getDoubleValue() — Method in class Literal
- double value.
- Literal::getStringValue() — Method in class Literal
- string value.
- Literal::getBytesValue() — Method in class Literal
- bytes value.
- Literal::getConstantKind() — Method in class Literal
- MapValue::getEntries() — Method in class MapValue
- The set of map entries.
- Entry::getKey() — Method in class Entry
- The key.
- Entry::getValue() — Method in class Entry
- The value.
- ParsedExpr::getExpr() — Method in class ParsedExpr
- The parsed expression.
- ParsedExpr::getSourceInfo() — Method in class ParsedExpr
- The source info derived from input that generated the parsed
expr
. - ParsedExpr::getSyntaxVersion() — Method in class ParsedExpr
- The syntax version of the source, e.g.
cel1
. - SourceInfo::getLocation() — Method in class SourceInfo
- The location name. All position information attached to an expression is relative to this location.
- SourceInfo::getLineOffsets() — Method in class SourceInfo
- Monotonically increasing list of character offsets where newlines appear.
- SourceInfo::getPositions() — Method in class SourceInfo
- A map from the parse node id (e.g.
Expr.id
) to the character offset within source. - SourcePosition::getLocation() — Method in class SourcePosition
- The soucre location name (e.g. file name).
- SourcePosition::getOffset() — Method in class SourcePosition
- The character offset.
- SourcePosition::getLine() — Method in class SourcePosition
- The 1-based index of the starting line in the source text where the issue occurs, or 0 if unknown.
- SourcePosition::getColumn() — Method in class SourcePosition
- The 0-based index of the starting position within the line of source text where the issue occurs. Only meaningful if line is nonzer.
- UnknownSet::getExprs() — Method in class UnknownSet
- The ids of the expressions with unknown values.
- Value::getNullValue() — Method in class Value
- Null value.
- Value::getBoolValue() — Method in class Value
- Boolean value.
- Value::getInt64Value() — Method in class Value
- Signed integer value.
- Value::getUint64Value() — Method in class Value
- Unsigned integer value.
- Value::getDoubleValue() — Method in class Value
- Floating point value.
- Value::getStringValue() — Method in class Value
- UTF-8 string value.
- Value::getBytesValue() — Method in class Value
- Byte string value.
- Value::getEnumValue() — Method in class Value
- An enum value.
- Value::getObjectValue() — Method in class Value
- The proto message backing an object value.
- Value::getMapValue() — Method in class Value
- Map value.
- Value::getListValue() — Method in class Value
- List value.
- Value::getTypeValue() — Method in class Value
- A Type value represented by the fully qualified name of the type.
- Value::getKind() — Method in class Value
- Http::getRules() — Method in class Http
- A list of HTTP configuration rules that apply to individual API methods.
- Http::getFullyDecodeReservedExpansion() — Method in class Http
- When set to true, URL path parmeters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded.
- HttpBody::getContentType() — Method in class HttpBody
- The HTTP Content-Type string representing the content type of the body.
- HttpBody::getData() — Method in class HttpBody
- HTTP body binary data.
- HttpBody::getExtensions() — Method in class HttpBody
- Application specific response metadata. Must be set in the first response for streaming APIs.
- HttpRule::getSelector() — Method in class HttpRule
- Selects methods to which this rule applies.
- HttpRule::getGet() — Method in class HttpRule
- Used for listing and getting information about resources.
- HttpRule::getPut() — Method in class HttpRule
- Used for updating a resource.
- HttpRule::getPost() — Method in class HttpRule
- Used for creating a resource.
- HttpRule::getDelete() — Method in class HttpRule
- Used for deleting a resource.
- HttpRule::getPatch() — Method in class HttpRule
- Used for updating a resource.
- HttpRule::getCustom() — Method in class HttpRule
- The custom pattern is used for specifying an HTTP method that is not
included in the
pattern
field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. - HttpRule::getBody() — Method in class HttpRule
- The name of the request field whose value is mapped to the HTTP body, or
*
for mapping all fields not captured by the path pattern to the HTTP body. NOTE: the referred field must not be a repeated field and must be present at the top-level of request message type. - HttpRule::getResponseBody() — Method in class HttpRule
- Optional. The name of the response field whose value is mapped to the HTTP body of response. Other response fields are ignored. When not set, the response message will be used as HTTP body of response.
- HttpRule::getAdditionalBindings() — Method in class HttpRule
- Additional HTTP bindings for the selector. Nested bindings must
not contain an
additional_bindings
field themselves (that is, the nesting may only be one level deep). - HttpRule::getPattern() — Method in class HttpRule
- LabelDescriptor::getKey() — Method in class LabelDescriptor
- The label key.
- LabelDescriptor::getValueType() — Method in class LabelDescriptor
- The type of data that can be assigned to the label.
- LabelDescriptor::getDescription() — Method in class LabelDescriptor
- A human-readable description for the label.
- LogDescriptor::getName() — Method in class LogDescriptor
- The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].
- LogDescriptor::getLabels() — Method in class LogDescriptor
- The set of labels that are available to describe a specific log entry.
- LogDescriptor::getDescription() — Method in class LogDescriptor
- A human-readable description of this log. This information appears in the documentation and can contain details.
- LogDescriptor::getDisplayName() — Method in class LogDescriptor
- The human-readable name for this log. This information appears on the user interface and should be concise.
- Logging::getProducerDestinations() — Method in class Logging
- Logging configurations for sending logs to the producer project.
- Logging::getConsumerDestinations() — Method in class Logging
- Logging configurations for sending logs to the consumer project.
- LoggingDestination::getMonitoredResource() — Method in class LoggingDestination
- The monitored resource type. The type must be defined in the [Service.monitored_resources][google.api.Service.monitored_resources] section.
- LoggingDestination::getLogs() — Method in class LoggingDestination
- Names of the logs to be sent to this destination. Each name must be defined in the [Service.logs][google.api.Service.logs] section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".
- Metric::getType() — Method in class Metric
- An existing metric type, see [google.api.MetricDescriptor][google.api.MetricDescriptor].
- Metric::getLabels() — Method in class Metric
- The set of label values that uniquely identify this metric. All
labels listed in the
MetricDescriptor
must be assigned values. - MetricDescriptor::getName() — Method in class MetricDescriptor
- The resource name of the metric descriptor.
- MetricDescriptor::getType() — Method in class MetricDescriptor
- The metric type, including its DNS name prefix. The type is not
URL-encoded. All user-defined metric types have the DNS name
custom.googleapis.com
orexternal.googleapis.com
. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" - MetricDescriptor::getLabels() — Method in class MetricDescriptor
- The set of labels that can be used to describe a specific
instance of this metric type. For example, the
appengine.googleapis.com/http/server/response_latencies
metric type has a label for the HTTP response code,response_code
, so you can look at latencies for successful responses or just for responses that failed. - MetricDescriptor::getMetricKind() — Method in class MetricDescriptor
- Whether the metric records instantaneous values, changes to a value, etc.
- MetricDescriptor::getValueType() — Method in class MetricDescriptor
- Whether the measurement is an integer, a floating-point number, etc.
- MetricDescriptor::getUnit() — Method in class MetricDescriptor
- The units in which the metric value is reported. It is only applicable
if the
value_type
isINT64
,DOUBLE
, orDISTRIBUTION
. Theunit
defines the representation of the stored metric values. - MetricDescriptor::getDescription() — Method in class MetricDescriptor
- A detailed description of the metric, which can be used in documentation.
- MetricDescriptor::getDisplayName() — Method in class MetricDescriptor
- A concise name for the metric, which can be displayed in user interfaces.
- MetricDescriptor::getMetadata() — Method in class MetricDescriptor
- Optional. Metadata which can be used to guide usage of the metric.
- MetricDescriptor::getLaunchStage() — Method in class MetricDescriptor
- Optional. The launch stage of the metric definition.
- MetricDescriptorMetadata::getLaunchStage() — Method in class MetricDescriptorMetadata
- Deprecated. Please use the MetricDescriptor.launch_stage instead.
- MetricDescriptorMetadata::getSamplePeriod() — Method in class MetricDescriptorMetadata
- The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.
- MetricDescriptorMetadata::getIngestDelay() — Method in class MetricDescriptorMetadata
- The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.
- MetricRule::getSelector() — Method in class MetricRule
- Selects the methods to which this rule applies.
- MetricRule::getMetricCosts() — Method in class MetricRule
- Metrics to update when the selected methods are called, and the associated cost applied to each metric.
- MonitoredResource::getType() — Method in class MonitoredResource
- Required. The monitored resource type. This field must match
the
type
field of a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] object. For example, the type of a Compute Engine VM instance isgce_instance
. - MonitoredResource::getLabels() — Method in class MonitoredResource
- Required. Values for all of the labels listed in the associated monitored
resource descriptor. For example, Compute Engine VM instances use the
labels
"project_id"
,"instance_id"
, and"zone"
. - MonitoredResourceDescriptor::getName() — Method in class MonitoredResourceDescriptor
- Optional. The resource name of the monitored resource descriptor:
"projects/{project_id}/monitoredResourceDescriptors/{type}"
where {type} is the value of thetype
field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format"monitoredResourceDescriptors/{type}"
. - MonitoredResourceDescriptor::getType() — Method in class MonitoredResourceDescriptor
- Required. The monitored resource type. For example, the type
"cloudsql_database"
represents databases in Google Cloud SQL. - MonitoredResourceDescriptor::getDisplayName() — Method in class MonitoredResourceDescriptor
- Optional. A concise name for the monitored resource type that might be
displayed in user interfaces. It should be a Title Cased Noun Phrase,
without any article or other determiners. For example,
"Google Cloud SQL Database"
. - MonitoredResourceDescriptor::getDescription() — Method in class MonitoredResourceDescriptor
- Optional. A detailed description of the monitored resource type that might be used in documentation.
- MonitoredResourceDescriptor::getLabels() — Method in class MonitoredResourceDescriptor
- Required. A set of labels used to describe instances of this monitored
resource type. For example, an individual Google Cloud SQL database is
identified by values for the labels
"database_id"
and"zone"
. - MonitoredResourceMetadata::getSystemLabels() — Method in class MonitoredResourceMetadata
- Output only. Values for predefined system metadata labels.
- MonitoredResourceMetadata::getUserLabels() — Method in class MonitoredResourceMetadata
- Output only. A map of user-defined metadata labels.
- Monitoring::getProducerDestinations() — Method in class Monitoring
- Monitoring configurations for sending metrics to the producer project.
- Monitoring::getConsumerDestinations() — Method in class Monitoring
- Monitoring configurations for sending metrics to the consumer project.
- MonitoringDestination::getMonitoredResource() — Method in class MonitoringDestination
- The monitored resource type. The type must be defined in [Service.monitored_resources][google.api.Service.monitored_resources] section.
- MonitoringDestination::getMetrics() — Method in class MonitoringDestination
- Names of the metrics to report to this monitoring destination.
- OAuthRequirements::getCanonicalScopes() — Method in class OAuthRequirements
- The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted.
- Page::getName() — Method in class Page
- The name of the page. It will be used as an identity of the page to
generate URI of the page, text of the link to this page in navigation,
etc. The full page name (start from the root page name to this page
concatenated with
.
) can be used as reference to the page in your documentation. For example:pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==)
You can reference
Java
page using Markdown reference link syntax:[Java][Tutorial.Java]
. - Page::getContent() — Method in class Page
- The Markdown content of the page. You can use
(== include {path} ==)
to include content from a Markdown file. - Page::getSubpages() — Method in class Page
- Subpages of this page. The order of subpages specified here will be honored in the generated docset.
- ProjectProperties::getProperties() — Method in class ProjectProperties
- List of per consumer project-specific properties.
- Property::getName() — Method in class Property
- The name of the property (a.k.a key).
- Property::getType() — Method in class Property
- The type of this property.
- Property::getDescription() — Method in class Property
- The description of the property
- Quota::getLimits() — Method in class Quota
- List of
QuotaLimit
definitions for the service. - Quota::getMetricRules() — Method in class Quota
- List of
MetricRule
definitions, each one mapping a selected method to one or more metrics. - QuotaLimit::getName() — Method in class QuotaLimit
- Name of the quota limit. The name is used to refer to the limit when overriding the default limit on per-consumer basis.
- QuotaLimit::getDescription() — Method in class QuotaLimit
- Optional. User-visible, extended description for this quota limit.
- QuotaLimit::getDefaultLimit() — Method in class QuotaLimit
- Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project.
- QuotaLimit::getMaxLimit() — Method in class QuotaLimit
- Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit.
- QuotaLimit::getFreeTier() — Method in class QuotaLimit
- Free tier value displayed in the Developers Console for this limit.
- QuotaLimit::getDuration() — Method in class QuotaLimit
- Duration of this limit in textual notation. Example: "100s", "24h", "1d".
- QuotaLimit::getMetric() — Method in class QuotaLimit
- The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config.
- QuotaLimit::getUnit() — Method in class QuotaLimit
- Specify the unit of the quota limit. It uses the same syntax as [Metric.unit][]. The supported unit kinds are determined by the quota backend system.
- QuotaLimit::getValues() — Method in class QuotaLimit
- Tiered limit values. Also allows for regional or zone overrides for these values if "/{region}" or "/{zone}" is specified in the unit field.
- QuotaLimit::getDisplayName() — Method in class QuotaLimit
- User-visible display name for this limit.
- ResourceDescriptor::getType() — Method in class ResourceDescriptor
- The resource type. It must be in the format of
{service_name}/{resource_type_kind}. The
resource_type_kind
must be singular and must not include version numbers. - ResourceDescriptor::getPattern() — Method in class ResourceDescriptor
- Optional. The relative resource name pattern associated with this resource type. The DNS prefix of the full resource name shouldn't be specified here.
- ResourceDescriptor::getNameField() — Method in class ResourceDescriptor
- Optional. The field on the resource that designates the resource name field. If omitted, this is assumed to be "name".
- ResourceDescriptor::getHistory() — Method in class ResourceDescriptor
- Optional. The historical or future-looking state of the resource pattern.
- ResourceDescriptor::getPlural() — Method in class ResourceDescriptor
- The plural name used in the resource name, such as 'projects' for
the name of 'projects/{project}'. It is the same concept of the
plural
field in k8s CRD spec https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/ - ResourceDescriptor::getSingular() — Method in class ResourceDescriptor
- The same concept of the
singular
field in k8s CRD spec https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/ Such as "project" for theresourcemanager.googleapis.com/Project
type. - ResourceReference::getType() — Method in class ResourceReference
- The resource type that the annotated field references.
- ResourceReference::getChildType() — Method in class ResourceReference
- The resource type of a child collection that the annotated field
references. This is useful for annotating the
parent
field that doesn't have a fixed resource type. - RoutingParameter::getField() — Method in class RoutingParameter
- A request field to extract the header key-value pair from.
- RoutingParameter::getPathTemplate() — Method in class RoutingParameter
- A pattern matching the key-value field. Optional.
- RoutingRule::getRoutingParameters() — Method in class RoutingRule
- A collection of Routing Parameter specifications.
- Service::getConfigVersion() — Method in class Service
- The semantic version of the service configuration. The config version affects the interpretation of the service configuration. For example, certain features are enabled by default for certain config versions.
- Service::getConfigVersionUnwrapped() — Method in class Service
- Returns the unboxed value from
getConfigVersion()
- Service::getName() — Method in class Service
- The DNS address at which this service is available,
e.g.
calendar.googleapis.com
. - Service::getId() — Method in class Service
- A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead.
- Service::getTitle() — Method in class Service
- The product title for this service.
- Service::getProducerProjectId() — Method in class Service
- The Google project that owns this service.
- Service::getApis() — Method in class Service
- A list of API interfaces exported by this service. Only the
name
field of the [google.protobuf.Api][google.protobuf.Api] needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. - Service::getTypes() — Method in class Service
- A list of all proto message types included in this API service.
- Service::getEnums() — Method in class Service
- A list of all enum types included in this API service. Enums
referenced directly or indirectly by the
apis
are automatically included. Enums which are not referenced but shall be included should be listed here by name. Example: enums: - name: google.someapi.v1.SomeEnum - Service::getDocumentation() — Method in class Service
- Additional API documentation.
- Service::getBackend() — Method in class Service
- API backend configuration.
- Service::getHttp() — Method in class Service
- HTTP configuration.
- Service::getQuota() — Method in class Service
- Quota configuration.
- Service::getAuthentication() — Method in class Service
- Auth configuration.
- Service::getContext() — Method in class Service
- Context configuration.
- Service::getUsage() — Method in class Service
- Configuration controlling usage of this service.
- Service::getEndpoints() — Method in class Service
- Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.
- Service::getControl() — Method in class Service
- Configuration for the service control plane.
- Service::getLogs() — Method in class Service
- Defines the logs used by this service.
- Service::getMetrics() — Method in class Service
- Defines the metrics used by this service.
- Service::getMonitoredResources() — Method in class Service
- Defines the monitored resources used by this service. This is required by the [Service.monitoring][google.api.Service.monitoring] and [Service.logging][google.api.Service.logging] configurations.
- Service::getBilling() — Method in class Service
- Billing configuration.
- Service::getLogging() — Method in class Service
- Logging configuration.
- Service::getMonitoring() — Method in class Service
- Monitoring configuration.
- Service::getSystemParameters() — Method in class Service
- System parameter configuration.
- Service::getSourceInfo() — Method in class Service
- Output only. The source information for this configuration if available.
- SourceInfo::getSourceFiles() — Method in class SourceInfo
- All files used during config generation.
- SystemParameter::getName() — Method in class SystemParameter
- Define the name of the parameter, such as "api_key" . It is case sensitive.
- SystemParameter::getHttpHeader() — Method in class SystemParameter
- Define the HTTP header name to use for the parameter. It is case insensitive.
- SystemParameter::getUrlQueryParameter() — Method in class SystemParameter
- Define the URL query parameter name to use for the parameter. It is case sensitive.
- SystemParameterRule::getSelector() — Method in class SystemParameterRule
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs.
- SystemParameterRule::getParameters() — Method in class SystemParameterRule
- Define parameters. Multiple names may be defined for a parameter.
- SystemParameters::getRules() — Method in class SystemParameters
- Define system parameters.
- Usage::getRequirements() — Method in class Usage
- Requirements that must be satisfied before a consumer project can use the
service. Each requirement is of the form <service.name>/
; for example 'serviceusage.googleapis.com/billing-enabled'. - Usage::getRules() — Method in class Usage
- A list of usage rules that apply to individual API methods.
- Usage::getProducerNotificationChannel() — Method in class Usage
- The full resource name of a channel used for sending notifications to the service producer.
- UsageRule::getSelector() — Method in class UsageRule
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs.
- UsageRule::getAllowUnregisteredCalls() — Method in class UsageRule
- If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
- UsageRule::getSkipServiceControl() — Method in class UsageRule
- If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available.
- AuditConfigDelta::getAction() — Method in class AuditConfigDelta
- The action that was performed on an audit configuration in a policy.
- AuditConfigDelta::getService() — Method in class AuditConfigDelta
- Specifies a service that was configured for Cloud Audit Logging.
- AuditConfigDelta::getExemptedMember() — Method in class AuditConfigDelta
- A single identity that is exempted from "data access" audit
logging for the
service
specified above. - AuditConfigDelta::getLogType() — Method in class AuditConfigDelta
- Specifies the log_type that was be enabled. ADMIN_ACTIVITY is always enabled, and cannot be configured.
- Binding::getRole() — Method in class Binding
- Role that is assigned to
members
. - Binding::getMembers() — Method in class Binding
- Specifies the identities requesting access for a Cloud Platform resource.
- Binding::getCondition() — Method in class Binding
- The condition that is associated with this binding.
- BindingDelta::getAction() — Method in class BindingDelta
- The action that was performed on a Binding.
- BindingDelta::getRole() — Method in class BindingDelta
- Role that is assigned to
members
. - BindingDelta::getMember() — Method in class BindingDelta
- A single identity requesting access for a Cloud Platform resource.
- BindingDelta::getCondition() — Method in class BindingDelta
- The condition that is associated with this binding.
- GetIamPolicyRequest — Class in namespace Google\Cloud\Iam\V1
- Request message for
GetIamPolicy
method. - GetIamPolicyRequest::getResource() — Method in class GetIamPolicyRequest
- REQUIRED: The resource for which the policy is being requested.
- GetIamPolicyRequest::getOptions() — Method in class GetIamPolicyRequest
- OPTIONAL: A
GetPolicyOptions
object for specifying options toGetIamPolicy
. This field is only used by Cloud IAM. - GetPolicyOptions — Class in namespace Google\Cloud\Iam\V1
- Encapsulates settings provided to GetIamPolicy.
- GetPolicyOptions::getRequestedPolicyVersion() — Method in class GetPolicyOptions
- Optional. The policy format version to be returned.
- Policy::getVersion() — Method in class Policy
- Specifies the format of the policy.
- Policy::getBindings() — Method in class Policy
- Associates a list of
members
to arole
. Optionally may specify acondition
that determines when binding is in effect. - Policy::getEtag() — Method in class Policy
etag
is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other.- PolicyDelta::getBindingDeltas() — Method in class PolicyDelta
- The delta for Bindings between two policies.
- PolicyDelta::getAuditConfigDeltas() — Method in class PolicyDelta
- The delta for AuditConfigs between two policies.
- SetIamPolicyRequest::getResource() — Method in class SetIamPolicyRequest
- REQUIRED: The resource for which the policy is being specified.
- SetIamPolicyRequest::getPolicy() — Method in class SetIamPolicyRequest
- REQUIRED: The complete policy to be applied to the
resource
. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. - TestIamPermissionsRequest::getResource() — Method in class TestIamPermissionsRequest
- REQUIRED: The resource for which the policy detail is being requested.
- TestIamPermissionsRequest::getPermissions() — Method in class TestIamPermissionsRequest
- The set of permissions to check for the
resource
. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview. - TestIamPermissionsResponse::getPermissions() — Method in class TestIamPermissionsResponse
- A subset of
TestPermissionsRequest.permissions
that the caller is allowed. - GetLocationRequest — Class in namespace Google\Cloud\Location
- The request message for [Locations.GetLocation][google.cloud.location.Locations.GetLocation].
- GetLocationRequest::getName() — Method in class GetLocationRequest
- Resource name for the location.
- ListLocationsRequest::getName() — Method in class ListLocationsRequest
- The resource that owns the locations collection, if applicable.
- ListLocationsRequest::getFilter() — Method in class ListLocationsRequest
- The standard list filter.
- ListLocationsRequest::getPageSize() — Method in class ListLocationsRequest
- The standard list page size.
- ListLocationsRequest::getPageToken() — Method in class ListLocationsRequest
- The standard list page token.
- ListLocationsResponse::getLocations() — Method in class ListLocationsResponse
- A list of locations that matches the specified filter in the request.
- ListLocationsResponse::getNextPageToken() — Method in class ListLocationsResponse
- The standard List next-page token.
- Location::getName() — Method in class Location
- Resource name for the location, which may vary between implementations.
- Location::getLocationId() — Method in class Location
- The canonical id for this location. For example:
"us-east1"
. - Location::getDisplayName() — Method in class Location
- The friendly name for this location, typically a nearby city name.
- Location::getLabels() — Method in class Location
- Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
- Location::getMetadata() — Method in class Location
- Service-specific metadata. For example the available capacity at the given location.
- HttpRequest::getRequestMethod() — Method in class HttpRequest
- The request method. Examples:
"GET"
,"HEAD"
,"PUT"
,"POST"
. - HttpRequest::getRequestUrl() — Method in class HttpRequest
- The scheme (http, https), the host name, the path and the query portion of the URL that was requested.
- HttpRequest::getRequestSize() — Method in class HttpRequest
- The size of the HTTP request message in bytes, including the request headers and the request body.
- HttpRequest::getStatus() — Method in class HttpRequest
- The response code indicating the status of response.
- HttpRequest::getResponseSize() — Method in class HttpRequest
- The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.
- HttpRequest::getUserAgent() — Method in class HttpRequest
- The user agent sent by the client. Example:
"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"
. - HttpRequest::getRemoteIp() — Method in class HttpRequest
- The IP address (IPv4 or IPv6) of the client that issued the HTTP
request. Examples:
"192.168.1.1"
,"FE80::0202:B3FF:FE1E:8329"
. - HttpRequest::getServerIp() — Method in class HttpRequest
- The IP address (IPv4 or IPv6) of the origin server that the request was sent to.
- HttpRequest::getReferer() — Method in class HttpRequest
- The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions.
- HttpRequest::getLatency() — Method in class HttpRequest
- The request processing latency on the server, from the time the request was received until the response was sent.
- HttpRequest::getCacheLookup() — Method in class HttpRequest
- Whether or not a cache lookup was attempted.
- HttpRequest::getCacheHit() — Method in class HttpRequest
- Whether or not an entity was served from cache (with or without validation).
- HttpRequest::getCacheValidatedWithOriginServer() — Method in class HttpRequest
- Whether or not the response was validated with the origin server before
being served from cache. This field is only meaningful if
cache_hit
is True. - HttpRequest::getCacheFillBytes() — Method in class HttpRequest
- The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.
- HttpRequest::getProtocol() — Method in class HttpRequest
- Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket"
- AuditData::getPolicyDelta() — Method in class AuditData
- Policy delta between the original policy and the newly set policy.
- BadRequest::getFieldViolations() — Method in class BadRequest
- Describes all violations in a client request.
- FieldViolation::getField() — Method in class FieldViolation
- A path leading to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field. E.g., "field_violations.field" would identify this field.
- FieldViolation::getDescription() — Method in class FieldViolation
- A description of why the request element is bad.
- DebugInfo::getStackEntries() — Method in class DebugInfo
- The stack trace entries indicating where the error occurred.
- DebugInfo::getDetail() — Method in class DebugInfo
- Additional debugging information provided by the server.
- ErrorInfo::getReason() — Method in class ErrorInfo
- The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match /[A-Z0-9_]+/.
- ErrorInfo::getDomain() — Method in class ErrorInfo
- The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
- ErrorInfo::getMetadata() — Method in class ErrorInfo
- Additional structured details about this error.
- Help::getLinks() — Method in class Help
- URL(s) pointing to additional information on handling the current error.
- Link::getDescription() — Method in class Link
- Describes what the link offers.
- Link::getUrl() — Method in class Link
- The URL of the link.
- LocalizedMessage::getLocale() — Method in class LocalizedMessage
- The locale used following the specification defined at http://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- LocalizedMessage::getMessage() — Method in class LocalizedMessage
- The localized error message in the above locale.
- PreconditionFailure::getViolations() — Method in class PreconditionFailure
- Describes all precondition violations.
- Violation::getType() — Method in class Violation
- The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, "TOS" for "Terms of Service violation".
- Violation::getSubject() — Method in class Violation
- The subject, relative to the type, that failed.
- Violation::getDescription() — Method in class Violation
- A description of how the precondition failed. Developers can use this description to understand how to fix the failure.
- QuotaFailure::getViolations() — Method in class QuotaFailure
- Describes all quota violations.
- Violation::getSubject() — Method in class Violation
- The subject on which the quota check failed.
- Violation::getDescription() — Method in class Violation
- A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.
- RequestInfo::getRequestId() — Method in class RequestInfo
- An opaque string that should only be interpreted by the service generating it. For example, it can be used to identify requests in the service's logs.
- RequestInfo::getServingData() — Method in class RequestInfo
- Any data that was used to serve this request. For example, an encrypted stack trace that can be sent back to the service provider for debugging.
- ResourceInfo::getResourceType() — Method in class ResourceInfo
- A name for the type of resource being accessed, e.g. "sql table", "cloud storage bucket", "file", "Google calendar"; or the type URL of the resource: e.g. "type.googleapis.com/google.pubsub.v1.Topic".
- ResourceInfo::getResourceName() — Method in class ResourceInfo
- The name of the resource being accessed. For example, a shared calendar name: "example.com_4fghdhgsrgh@group.calendar.google.com", if the current error is [google.rpc.Code.PERMISSION_DENIED][google.rpc.Code.PERMISSION_DENIED].
- ResourceInfo::getOwner() — Method in class ResourceInfo
- The owner of the resource (optional).
- ResourceInfo::getDescription() — Method in class ResourceInfo
- Describes what error is encountered when accessing this resource.
- RetryInfo::getRetryDelay() — Method in class RetryInfo
- Clients should wait at least this long between retrying the same request.
- Status::getCode() — Method in class Status
- The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
- Status::getMessage() — Method in class Status
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- Status::getDetails() — Method in class Status
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- Color::getRed() — Method in class Color
- The amount of red in the color as a value in the interval [0, 1].
- Color::getGreen() — Method in class Color
- The amount of green in the color as a value in the interval [0, 1].
- Color::getBlue() — Method in class Color
- The amount of blue in the color as a value in the interval [0, 1].
- Color::getAlpha() — Method in class Color
- The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset.
- Color::getAlphaUnwrapped() — Method in class Color
- Returns the unboxed value from
getAlpha()
- Date::getYear() — Method in class Date
- Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
- Date::getMonth() — Method in class Date
- Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
- Date::getDay() — Method in class Date
- Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.
- DateTime::getYear() — Method in class DateTime
- Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
- DateTime::getMonth() — Method in class DateTime
- Required. Month of year. Must be from 1 to 12.
- DateTime::getDay() — Method in class DateTime
- Required. Day of month. Must be from 1 to 31 and valid for the year and month.
- DateTime::getHours() — Method in class DateTime
- Required. Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
- DateTime::getMinutes() — Method in class DateTime
- Required. Minutes of hour of day. Must be from 0 to 59.
- DateTime::getSeconds() — Method in class DateTime
- Required. Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
- DateTime::getNanos() — Method in class DateTime
- Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
- DateTime::getUtcOffset() — Method in class DateTime
- UTC offset. Must be whole seconds, between -18 hours and +18 hours.
- DateTime::getTimeZone() — Method in class DateTime
- Time zone.
- DateTime::getTimeOffset() — Method in class DateTime
- Decimal::getValue() — Method in class Decimal
- The decimal value, as a string.
- Expr::getExpression() — Method in class Expr
- Textual representation of an expression in Common Expression Language syntax.
- Expr::getTitle() — Method in class Expr
- An 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.
- Expr::getDescription() — Method in class Expr
- An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
- Expr::getLocation() — Method in class Expr
- An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
- Fraction::getNumerator() — Method in class Fraction
- The portion of the denominator in the faction, e.g. 2 in 2/3.
- Fraction::getDenominator() — Method in class Fraction
- The value by which the numerator is divided, e.g. 3 in 2/3. Must be positive.
- Interval::getStartTime() — Method in class Interval
- Optional. Inclusive start of the interval.
- Interval::getEndTime() — Method in class Interval
- Optional. Exclusive end of the interval.
- LatLng::getLatitude() — Method in class LatLng
- The latitude in degrees. It must be in the range [-90.0, +90.0].
- LatLng::getLongitude() — Method in class LatLng
- The longitude in degrees. It must be in the range [-180.0, +180.0].
- LocalizedText::getText() — Method in class LocalizedText
- Localized string in the language corresponding to `language_code' below.
- LocalizedText::getLanguageCode() — Method in class LocalizedText
- The text's BCP-47 language code, such as "en-US" or "sr-Latn".
- Money::getCurrencyCode() — Method in class Money
- The 3-letter currency code defined in ISO 4217.
- Money::getUnits() — Method in class Money
- The whole units of the amount.
- Money::getNanos() — Method in class Money
- Number of nano (10^-9) units of the amount.
- PhoneNumber::getE164Number() — Method in class PhoneNumber
- The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123".
- PhoneNumber::getShortCode() — Method in class PhoneNumber
- A short code.
- PhoneNumber::getExtension() — Method in class PhoneNumber
- The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here.
- PhoneNumber::getKind() — Method in class PhoneNumber
- ShortCode::getRegionCode() — Method in class ShortCode
- Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB".
- ShortCode::getNumber() — Method in class ShortCode
- Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
- PostalAddress::getRevision() — Method in class PostalAddress
- The schema revision of the
PostalAddress
. This must be set to 0, which is the latest revision. - PostalAddress::getRegionCode() — Method in class PostalAddress
- Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
- PostalAddress::getLanguageCode() — Method in class PostalAddress
- Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents.
- PostalAddress::getPostalCode() — Method in class PostalAddress
- Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
- PostalAddress::getSortingCode() — Method in class PostalAddress
- Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
- PostalAddress::getAdministrativeArea() — Method in class PostalAddress
- Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
- PostalAddress::getLocality() — Method in class PostalAddress
- Optional. Generally refers to the city/town portion of the address.
- PostalAddress::getSublocality() — Method in class PostalAddress
- Optional. Sublocality of the address.
- PostalAddress::getAddressLines() — Method in class PostalAddress
- Unstructured address lines describing the lower levels of an address.
- PostalAddress::getRecipients() — Method in class PostalAddress
- Optional. The recipient at the address.
- PostalAddress::getOrganization() — Method in class PostalAddress
- Optional. The name of the organization at the address.
- Quaternion::getX() — Method in class Quaternion
- The x component.
- Quaternion::getY() — Method in class Quaternion
- The y component.
- Quaternion::getZ() — Method in class Quaternion
- The z component.
- Quaternion::getW() — Method in class Quaternion
- The scalar component.
- TimeOfDay::getHours() — Method in class TimeOfDay
- Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
- TimeOfDay::getMinutes() — Method in class TimeOfDay
- Minutes of hour of day. Must be from 0 to 59.
- TimeOfDay::getSeconds() — Method in class TimeOfDay
- Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
- TimeOfDay::getNanos() — Method in class TimeOfDay
- Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
- TimeZone::getId() — Method in class TimeZone
- IANA Time Zone Database time zone, e.g. "America/New_York".
- TimeZone::getVersion() — Method in class TimeZone
- Optional. IANA Time Zone Database version number, e.g. "2019a".
H
- Http — Class in namespace Google\Api
- Defines the HTTP configuration for an API service. It contains a list of [HttpRule][google.api.HttpRule], each specifying the mapping of an RPC method to one or more HTTP REST API methods.
- HttpBody — Class in namespace Google\Api
- Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page.
- HttpRule — Class in namespace Google\Api
HttpRule
defines the mapping of an RPC method to one or more HTTP REST API methods. The mapping specifies how different portions of the RPC request message are mapped to URL path, URL query parameters, and HTTP request body. The mapping is typically specified as angoogle.api.http
annotation on the RPC method, see "google/api/annotations.proto" for details.- History — Class in namespace Google\Api\ResourceDescriptor
- A description of the historical or future-looking state of the resource pattern.
- Location::hasMetadata() — Method in class Location
- HttpRequest — Class in namespace Google\Cloud\Logging\Type
- A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message.
- Help — Class in namespace Google\Rpc
- Provides links to documentation or for performing an out of band action.
- Help_Link — Class in namespace Google\Rpc
- This class is deprecated. Use Google\Rpc\Help\Link instead.
- RetryInfo::hasRetryDelay() — Method in class RetryInfo
- Interval::hasStartTime() — Method in class Interval
- Interval::hasEndTime() — Method in class Interval
- PhoneNumber::hasE164Number() — Method in class PhoneNumber
- PhoneNumber::hasShortCode() — Method in class PhoneNumber
I
- IdentDecl — Class in namespace Google\Api\Expr\V1alpha1\Decl
- Identifier declaration which specifies its type and optional
Expr
value. - Ident — Class in namespace Google\Api\Expr\V1alpha1\Expr
- An identifier expression. e.g.
request
. - IssueDetails — Class in namespace Google\Api\Expr\V1alpha1
- Warnings or errors in service execution are represented by [google.rpc.Status][google.rpc.Status] messages, with the following message in the details field.
- IssueDetails_Severity — Class in namespace Google\Api\Expr\V1alpha1
- This class is deprecated. Use Google\Api\Expr\V1alpha1\IssueDetails\Severity instead.
- Ident — Class in namespace Google\Api\Expr\V1beta1\Expr
- An identifier expression. e.g.
request
. - IdRef — Class in namespace Google\Api\Expr\V1beta1
- A reference to an expression id.
- IdentDecl — Class in namespace Google\Api\Expr\V1beta1
- An identifier declaration.
- Interval — Class in namespace Google\Type
- Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).
K
- $ExprValue#kind — Property in class ExprValue
- $Entry#key_kind — Property in class Entry
- $Value#kind — Property in class Value
- $Decl#kind — Property in class Decl
- $ExprValue#kind — Property in class ExprValue
- $Entry#key_kind — Property in class Entry
- $Value#kind — Property in class Value
- $PhoneNumber#kind — Property in class PhoneNumber
L
- Linear — Class in namespace Google\Api\Distribution\BucketOptions
- Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.
- ListValue — Class in namespace Google\Api\Expr\V1alpha1
- A list.
- ListType — Class in namespace Google\Api\Expr\V1alpha1\Type
- List type with typed elements, e.g.
list<example.proto.MyMessage>
. - ListValue — Class in namespace Google\Api\Expr\V1beta1
- A list.
- Literal — Class in namespace Google\Api\Expr\V1beta1
- Represents a primitive literal.
- LabelDescriptor — Class in namespace Google\Api
- A description of a label.
- LabelDescriptor_ValueType — Class in namespace Google\Api
- This class is deprecated. Use Google\Api\LabelDescriptor\ValueType instead.
- LaunchStage — Class in namespace Google\Api
- The launch stage as defined by Google Cloud Platform Launch Stages.
- LogDescriptor — Class in namespace Google\Api
- A description of a log type. Example in YAML format: - name: library.googleapis.com/activity_history description: The history of borrowing and returning library items.
- Logging — Class in namespace Google\Api
- Logging configuration of the service.
- LoggingDestination — Class in namespace Google\Api\Logging
- Configuration of a specific logging destination (the producer project or the consumer project).
- Logging_LoggingDestination — Class in namespace Google\Api
- This class is deprecated. Use Google\Api\Logging\LoggingDestination instead.
- ListLocationsRequest — Class in namespace Google\Cloud\Location
- The request message for [Locations.ListLocations][google.cloud.location.Locations.ListLocations].
- ListLocationsResponse — Class in namespace Google\Cloud\Location
- The response message for [Locations.ListLocations][google.cloud.location.Locations.ListLocations].
- Location — Class in namespace Google\Cloud\Location
- A resource that represents Google Cloud Platform location.
- $Location#location_id — Property in class Location
- The canonical id for this location. For example:
"us-east1"
. - LogSeverity — Class in namespace Google\Cloud\Logging\Type
- The severity of the event described in a log entry, expressed as one of the standard severity levels listed below. For your reference, the levels are assigned the listed numeric values. The effect of using numeric values other than those listed is undefined.
- Link — Class in namespace Google\Rpc\Help
- Describes a URL link.
- LocalizedMessage — Class in namespace Google\Rpc
- Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
- $LocalizedMessage#locale — Property in class LocalizedMessage
- The locale used following the specification defined at http://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- LatLng — Class in namespace Google\Type
- An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.
- LocalizedText — Class in namespace Google\Type
- Localized variant of a text in a particular language.
- $LocalizedText#language_code — Property in class LocalizedText
- The text's BCP-47 language code, such as "en-US" or "sr-Latn".
M
- MapValue — Class in namespace Google\Api\Expr\V1alpha1
- A map.
- MapValue_Entry — Class in namespace Google\Api\Expr\V1alpha1
- This class is deprecated. Use Google\Api\Expr\V1alpha1\MapValue\Entry instead.
- MapType — Class in namespace Google\Api\Expr\V1alpha1\Type
- Map type with parameterized key and value types, e.g.
map<string, int>
. - MapValue — Class in namespace Google\Api\Expr\V1beta1
- A map.
- MapValue_Entry — Class in namespace Google\Api\Expr\V1beta1
- This class is deprecated. Use Google\Api\Expr\V1beta1\MapValue\Entry instead.
- Metric — Class in namespace Google\Api
- A specific metric, identified by specifying values for all of the
labels of a [
MetricDescriptor
][google.api.MetricDescriptor]. - MetricDescriptor — Class in namespace Google\Api
- Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.
- MetricDescriptorMetadata — Class in namespace Google\Api\MetricDescriptor
- Additional annotations that can be used to guide the usage of a metric.
- MetricKind — Class in namespace Google\Api\MetricDescriptor
- The kind of measurement. It describes how the data is reported.
- MetricDescriptor_MetricDescriptorMetadata — Class in namespace Google\Api
- This class is deprecated. Use Google\Api\MetricDescriptor\MetricDescriptorMetadata instead.
- MetricDescriptor_MetricKind — Class in namespace Google\Api
- This class is deprecated. Use Google\Api\MetricDescriptor\MetricKind instead.
- MetricDescriptor_ValueType — Class in namespace Google\Api
- This class is deprecated. Use Google\Api\MetricDescriptor\ValueType instead.
- MetricRule — Class in namespace Google\Api
- Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota, billing, and monitoring behaviors to apply to the method call.
- MonitoredResource — Class in namespace Google\Api
- An object representing a resource that can be used for monitoring, logging,
billing, or other purposes. Examples include virtual machine instances,
databases, and storage devices such as disks. The
type
field identifies a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] object that describes the resource's schema. Information in thelabels
field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] for"gce_instance"
has labels"instance_id"
and"zone"
: { "type": "gce_instance", "labels": { "instance_id": "12345678901234", "zone": "us-central1-a" }} - MonitoredResourceDescriptor — Class in namespace Google\Api
- An object that describes the schema of a [MonitoredResource][google.api.MonitoredResource] object using a
type name and a set of labels. For example, the monitored resource
descriptor for Google Compute Engine VM instances has a type of
"gce_instance"
and specifies the use of the labels"instance_id"
and"zone"
to identify particular VM instances. - MonitoredResourceMetadata — Class in namespace Google\Api
- Auxiliary metadata for a [MonitoredResource][google.api.MonitoredResource] object.
- Monitoring — Class in namespace Google\Api
- Monitoring configuration of the service.
- MonitoringDestination — Class in namespace Google\Api\Monitoring
- Configuration of a specific monitoring destination (the producer project or the consumer project).
- Monitoring_MonitoringDestination — Class in namespace Google\Api
- This class is deprecated. Use Google\Api\Monitoring\MonitoringDestination instead.
- $Location#metadata — Property in class Location
- Service-specific metadata. For example the available capacity at the given location.
- $LocalizedMessage#message — Property in class LocalizedMessage
- The localized error message in the above locale.
- $Status#message — Property in class Status
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- Money — Class in namespace Google\Type
- Represents an amount of money with its currency type.
- Month — Class in namespace Google\Type
- Represents a month in the Gregorian calendar.
N
- PathTranslation::name() — Method in class PathTranslation
- ChangeType::name() — Method in class ChangeType
- Severity::name() — Method in class Severity
- PrimitiveType::name() — Method in class PrimitiveType
- WellKnownType::name() — Method in class WellKnownType
- FieldBehavior::name() — Method in class FieldBehavior
- ValueType::name() — Method in class ValueType
- LaunchStage::name() — Method in class LaunchStage
- MetricKind::name() — Method in class MetricKind
- ValueType::name() — Method in class ValueType
- PropertyType::name() — Method in class PropertyType
- History::name() — Method in class History
- Action::name() — Method in class Action
- Action::name() — Method in class Action
- $GetLocationRequest#name — Property in class GetLocationRequest
- Resource name for the location.
- $ListLocationsRequest#name — Property in class ListLocationsRequest
- The resource that owns the locations collection, if applicable.
- $ListLocationsResponse#next_page_token — Property in class ListLocationsResponse
- The standard List next-page token.
- $Location#name — Property in class Location
- Resource name for the location, which may vary between implementations.
- LogSeverity::name() — Method in class LogSeverity
- OperationResponseMapping::name() — Method in class OperationResponseMapping
- Code::name() — Method in class Code
- CalendarPeriod::name() — Method in class CalendarPeriod
- DayOfWeek::name() — Method in class DayOfWeek
- Month::name() — Method in class Month
- $ShortCode#number — Property in class ShortCode
- Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
O
- $BucketOptions#options — Property in class BucketOptions
- Overload — Class in namespace Google\Api\Expr\V1alpha1\Decl\FunctionDecl
- An overload indicates a function's parameter types and return type, and may optionally include a function body described in terms of [Expr][google.api.expr.v1alpha1.Expr] values.
- OAuthRequirements — Class in namespace Google\Api
- OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application, giving it permission to access that data on their behalf.
- OperationResponseMapping — Class in namespace Google\Cloud
- An enum to be used to mark the essential (for polling) fields in an API-specific Operation object. A custom Operation object may contain many different fields, but only few of them are essential to conduct a successful polling process.
- $ResourceInfo#owner — Property in class ResourceInfo
- The owner of the resource (optional).
P
- PathTranslation — Class in namespace Google\Api\BackendRule
- Path Translation specifies how to combine the backend address with the request path in order to produce the appropriate forwarding URL for the request.
- ParseRequest — Class in namespace Google\Api\Expr\V1alpha1
- Request message for the Parse method.
- ParseResponse — Class in namespace Google\Api\Expr\V1alpha1
- Response message for the Parse method.
- ParsedExpr — Class in namespace Google\Api\Expr\V1alpha1
- An expression together with source information as returned by the parser.
- PrimitiveType — Class in namespace Google\Api\Expr\V1alpha1\Type
- CEL primitive types.
- ParsedExpr — Class in namespace Google\Api\Expr\V1beta1
- An expression together with source information as returned by the parser.
- $HttpRule#pattern — Property in class HttpRule
- Page — Class in namespace Google\Api
- Represents a documentation page. A page can contain subpages to represent nested documentation set structure.
- ProjectProperties — Class in namespace Google\Api
- A descriptor for defining project properties for a service. One service may have many consumer projects, and the service may want to behave differently depending on some properties on the project. For example, a project may be associated with a school, or a business, or a government agency, a business type property on the project may affect how a service responds to the client.
- Property — Class in namespace Google\Api
- Defines project properties.
- PropertyType — Class in namespace Google\Api\Property
- Supported data type of the property values
- Property_PropertyType — Class in namespace Google\Api
- This class is deprecated. Use Google\Api\Property\PropertyType instead.
- $RoutingParameter#path_template — Property in class RoutingParameter
- A pattern matching the key-value field. Optional.
- Policy — Class in namespace Google\Cloud\Iam\V1
- Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
- PolicyDelta — Class in namespace Google\Cloud\Iam\V1
- The difference delta between two policies.
- $ListLocationsRequest#page_size — Property in class ListLocationsRequest
- The standard list page size.
- $ListLocationsRequest#page_token — Property in class ListLocationsRequest
- The standard list page token.
- PreconditionFailure — Class in namespace Google\Rpc
- Describes what preconditions have failed.
- PreconditionFailure_Violation — Class in namespace Google\Rpc
- This class is deprecated. Use Google\Rpc\PreconditionFailure\Violation instead.
- PhoneNumber — Class in namespace Google\Type
- An object representing a phone number, suitable as an API wire format.
- PostalAddress — Class in namespace Google\Type
- Represents a postal address, e.g. for postal delivery or payments addresses.
Q
- Quota — Class in namespace Google\Api
- Quota configuration helps to achieve fairness and budgeting in service usage.
- QuotaLimit — Class in namespace Google\Api
QuotaLimit
defines a specific limit that applies over a specified duration for a limit type. There can be at most one limit for a duration and limit type combination defined within aQuotaGroup
.- QuotaFailure — Class in namespace Google\Rpc
- Describes how a quota check failed.
- QuotaFailure_Violation — Class in namespace Google\Rpc
- This class is deprecated. Use Google\Rpc\QuotaFailure\Violation instead.
- Quaternion — Class in namespace Google\Type
- A quaternion is defined as the quotient of two directed lines in a three-dimensional space or equivalently as the quotient of two Euclidean vectors (https://en.wikipedia.org/wiki/Quaternion).
R
- Range — Class in namespace Google\Api\Distribution
- The range of the population values.
- Result — Class in namespace Google\Api\Expr\V1alpha1\EvalState
- A single evalution result.
- Reference — Class in namespace Google\Api\Expr\V1alpha1
- Describes a resolved reference to a declaration.
- Result — Class in namespace Google\Api\Expr\V1beta1\EvalState
- A single evaluation result.
- ResourceDescriptor — Class in namespace Google\Api
- A simple descriptor of a resource type.
- ResourceDescriptor_History — Class in namespace Google\Api
- This class is deprecated. Use Google\Api\ResourceDescriptor\History instead.
- ResourceReference — Class in namespace Google\Api
- Defines a proto annotation that describes a string field that refers to an API resource.
- RoutingParameter — Class in namespace Google\Api
- A projection from an input message to the GRPC or REST header.
- RoutingRule — Class in namespace Google\Api
- Specifies the routing information that should be sent along with the request in the form of routing header.
- $ErrorInfo#reason — Property in class ErrorInfo
- The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match /[A-Z0-9_]+/.
- RequestInfo — Class in namespace Google\Rpc
- Contains metadata about the request that clients can attach when filing a bug or providing other forms of feedback.
- $RequestInfo#request_id — Property in class RequestInfo
- An opaque string that should only be interpreted by the service generating it. For example, it can be used to identify requests in the service's logs.
- ResourceInfo — Class in namespace Google\Rpc
- Describes the resource that is being accessed.
- $ResourceInfo#resource_type — Property in class ResourceInfo
- A name for the type of resource being accessed, e.g. "sql table", "cloud storage bucket", "file", "Google calendar"; or the type URL of the resource: e.g. "type.googleapis.com/google.pubsub.v1.Topic".
- $ResourceInfo#resource_name — Property in class ResourceInfo
- The name of the resource being accessed. For example, a shared calendar name: "example.com_4fghdhgsrgh@group.calendar.google.com", if the current error is [google.rpc.Code.PERMISSION_DENIED][google.rpc.Code.PERMISSION_DENIED].
- RetryInfo — Class in namespace Google\Rpc
- Describes when the clients can retry a failed request. Clients could ignore the recommendation here or retry when this information is missing from error responses.
- $RetryInfo#retry_delay — Property in class RetryInfo
- Clients should wait at least this long between retrying the same request.
- $ShortCode#region_code — Property in class ShortCode
- Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB".
S
- Advice::setDescription() — Method in class Advice
- Useful description for why this advice was applied and what actions should be taken to mitigate any implied risks.
- AuthProvider::setId() — Method in class AuthProvider
- The unique identifier of the auth provider. It will be referred to by
AuthRequirement.provider_id
. - AuthProvider::setIssuer() — Method in class AuthProvider
- Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address.
- AuthProvider::setJwksUri() — Method in class AuthProvider
- URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery.
- AuthProvider::setAudiences() — Method in class AuthProvider
- The list of JWT audiences.
- AuthProvider::setAuthorizationUrl() — Method in class AuthProvider
- Redirect URL if JWT token is required but no present or is expired.
- AuthRequirement::setProviderId() — Method in class AuthRequirement
- [id][google.api.AuthProvider.id] from authentication provider.
- AuthRequirement::setAudiences() — Method in class AuthRequirement
- NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components.
- Authentication::setRules() — Method in class Authentication
- A list of authentication rules that apply to individual API methods.
- Authentication::setProviders() — Method in class Authentication
- Defines a set of authentication providers that a service supports.
- AuthenticationRule::setSelector() — Method in class AuthenticationRule
- Selects the methods to which this rule applies.
- AuthenticationRule::setOauth() — Method in class AuthenticationRule
- The requirements for OAuth credentials.
- AuthenticationRule::setAllowWithoutCredential() — Method in class AuthenticationRule
- If true, the service accepts API keys without any other credential.
- AuthenticationRule::setRequirements() — Method in class AuthenticationRule
- Requirements for additional authentication providers.
- Backend::setRules() — Method in class Backend
- A list of API backend rules that apply to individual API methods.
- BackendRule::setSelector() — Method in class BackendRule
- Selects the methods to which this rule applies.
- BackendRule::setAddress() — Method in class BackendRule
- The address of the API backend.
- BackendRule::setDeadline() — Method in class BackendRule
- The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
- BackendRule::setMinDeadline() — Method in class BackendRule
- Minimum deadline in seconds needed for this method. Calls having deadline value lower than this will be rejected.
- BackendRule::setOperationDeadline() — Method in class BackendRule
- The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- BackendRule::setPathTranslation() — Method in class BackendRule
- Generated from protobuf field
.google.api.BackendRule.PathTranslation path_translation = 6;
- BackendRule::setJwtAudience() — Method in class BackendRule
- The JWT audience is used when generating a JWT ID token for the backend.
- BackendRule::setDisableAuth() — Method in class BackendRule
- When disable_auth is false, a JWT ID token will be generated with the value from [BackendRule.address][google.api.BackendRule.address] as jwt_audience, overrode to the HTTP "Authorization" request header and sent to the backend.
- Billing::setConsumerDestinations() — Method in class Billing
- Billing configurations for sending metrics to the consumer project.
- BillingDestination::setMonitoredResource() — Method in class BillingDestination
- The monitored resource type. The type must be defined in [Service.monitored_resources][google.api.Service.monitored_resources] section.
- BillingDestination::setMetrics() — Method in class BillingDestination
- Names of the metrics to report to this billing destination.
- ConfigChange::setElement() — Method in class ConfigChange
- Object hierarchy path to the change, with levels separated by a '.' character. For repeated fields, an applicable unique identifier field is used for the index (usually selector, name, or id). For maps, the term 'key' is used. If the field has no unique identifier, the numeric index is used.
- ConfigChange::setOldValue() — Method in class ConfigChange
- Value of the changed object in the old Service configuration, in JSON format. This field will not be populated if ChangeType == ADDED.
- ConfigChange::setNewValue() — Method in class ConfigChange
- Value of the changed object in the new Service configuration, in JSON format. This field will not be populated if ChangeType == REMOVED.
- ConfigChange::setChangeType() — Method in class ConfigChange
- The type for this change, either ADDED, REMOVED, or MODIFIED.
- ConfigChange::setAdvices() — Method in class ConfigChange
- Collection of advice provided for this change, useful for determining the possible impact of this change.
- Context::setRules() — Method in class Context
- A list of RPC context rules that apply to individual API methods.
- ContextRule::setSelector() — Method in class ContextRule
- Selects the methods to which this rule applies.
- ContextRule::setRequested() — Method in class ContextRule
- A list of full type names of requested contexts.
- ContextRule::setProvided() — Method in class ContextRule
- A list of full type names of provided contexts.
- Control::setEnvironment() — Method in class Control
- The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled.
- CustomHttpPattern::setKind() — Method in class CustomHttpPattern
- The name of this custom HTTP verb.
- CustomHttpPattern::setPath() — Method in class CustomHttpPattern
- The path matched by this custom verb.
- Distribution::setCount() — Method in class Distribution
- The number of values in the population. Must be non-negative. This value
must equal the sum of the values in
bucket_counts
if a histogram is provided. - Distribution::setMean() — Method in class Distribution
- The arithmetic mean of the values in the population. If
count
is zero then this field must be zero. - Distribution::setSumOfSquaredDeviation() — Method in class Distribution
- The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1.
- Distribution::setRange() — Method in class Distribution
- If specified, contains the range of the population values. The field
must not be present if the
count
is zero. - Distribution::setBucketOptions() — Method in class Distribution
- Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field.
- Distribution::setBucketCounts() — Method in class Distribution
- The number of values in each bucket of the histogram, as described in
bucket_options
. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values inbucket_counts
must equal the value in thecount
field of the distribution. - Distribution::setExemplars() — Method in class Distribution
- Must be in increasing order of
value
field. - BucketOptions::setLinearBuckets() — Method in class BucketOptions
- The linear bucket.
- BucketOptions::setExponentialBuckets() — Method in class BucketOptions
- The exponential buckets.
- BucketOptions::setExplicitBuckets() — Method in class BucketOptions
- The explicit buckets.
- Explicit::setBounds() — Method in class Explicit
- The values must be monotonically increasing.
- Exponential::setNumFiniteBuckets() — Method in class Exponential
- Must be greater than 0.
- Exponential::setGrowthFactor() — Method in class Exponential
- Must be greater than 1.
- Exponential::setScale() — Method in class Exponential
- Must be greater than 0.
- Linear::setNumFiniteBuckets() — Method in class Linear
- Must be greater than 0.
- Linear::setWidth() — Method in class Linear
- Must be greater than 0.
- Linear::setOffset() — Method in class Linear
- Lower bound of the first bucket.
- Exemplar::setValue() — Method in class Exemplar
- Value of the exemplar point. This value determines to which bucket the exemplar belongs.
- Exemplar::setTimestamp() — Method in class Exemplar
- The observation (sampling) time of the above value.
- Exemplar::setAttachments() — Method in class Exemplar
- Contextual information about the example value. Examples are: Trace ID: type.googleapis.com/google.devtools.cloudtrace.v1.Trace Literal string: type.googleapis.com/google.protobuf.StringValue Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.
- Range::setMin() — Method in class Range
- The minimum of the population values.
- Range::setMax() — Method in class Range
- The maximum of the population values.
- Documentation::setSummary() — Method in class Documentation
- A short summary of what the service does. Can only be provided by plain text.
- Documentation::setPages() — Method in class Documentation
- The top level pages for the documentation set.
- Documentation::setRules() — Method in class Documentation
- A list of documentation rules that apply to individual API elements.
- Documentation::setDocumentationRootUrl() — Method in class Documentation
- The URL to the root of documentation.
- Documentation::setOverview() — Method in class Documentation
- Declares a single overview page. For example:
<
pre>
documentation: summary: .
- DocumentationRule::setSelector() — Method in class DocumentationRule
- The selector is a comma-separated list of patterns. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard.
- DocumentationRule::setDescription() — Method in class DocumentationRule
- Description of the selected API(s).
- DocumentationRule::setDeprecationDescription() — Method in class DocumentationRule
- Deprecation description of the selected element(s). It can be provided if an
element is marked as
deprecated
. - Endpoint::setName() — Method in class Endpoint
- The canonical name of this endpoint.
- Endpoint::setAliases() — Method in class Endpoint
- DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple [google.api.Endpoint][google.api.Endpoint] for each of the intended aliases.
- Endpoint::setFeatures() — Method in class Endpoint
- The list of features enabled on this endpoint.
- Endpoint::setTarget() — Method in class Endpoint
- The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint.
- Endpoint::setAllowCors() — Method in class Endpoint
- Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.
- CheckRequest::setParsedExpr() — Method in class CheckRequest
- Required. The parsed representation of the CEL program.
- CheckRequest::setTypeEnv() — Method in class CheckRequest
- Declarations of types for external variables and functions.
- CheckRequest::setContainer() — Method in class CheckRequest
- The protocol buffer context. See "Name Resolution" in the Language Definition.
- CheckRequest::setNoStdEnv() — Method in class CheckRequest
- If true, use only the declarations in [type_env][google.api.expr.v1alpha1.CheckRequest.type_env]. If false (default), add declarations for the standard definitions to the type environment. See "Standard Definitions" in the Language Definition.
- CheckResponse::setCheckedExpr() — Method in class CheckResponse
- The annotated representation, or unset if checking failed.
- CheckResponse::setIssues() — Method in class CheckResponse
- Any number of issues with [StatusDetails][] as the details.
- CheckedExpr::setReferenceMap() — Method in class CheckedExpr
- A map from expression ids to resolved references.
- CheckedExpr::setTypeMap() — Method in class CheckedExpr
- A map from expression ids to types.
- CheckedExpr::setSourceInfo() — Method in class CheckedExpr
- The source info derived from input that generated the parsed
expr
and any optimizations made during the type-checking pass. - CheckedExpr::setExpr() — Method in class CheckedExpr
- The checked expression. Semantically equivalent to the parsed
expr
, but may have structural differences. - Constant::setNullValue() — Method in class Constant
- null value.
- Constant::setBoolValue() — Method in class Constant
- boolean value.
- Constant::setInt64Value() — Method in class Constant
- int64 value.
- Constant::setUint64Value() — Method in class Constant
- uint64 value.
- Constant::setDoubleValue() — Method in class Constant
- double value.
- Constant::setStringValue() — Method in class Constant
- string value.
- Constant::setBytesValue() — Method in class Constant
- bytes value.
- Constant::setDurationValue() — Method in class Constant
- protobuf.Duration value.
- Constant::setTimestampValue() — Method in class Constant
- protobuf.Timestamp value.
- Decl::setName() — Method in class Decl
- The fully qualified name of the declaration.
- Decl::setIdent() — Method in class Decl
- Identifier declaration.
- Decl::setFunction() — Method in class Decl
- Function declaration.
- FunctionDecl::setOverloads() — Method in class FunctionDecl
- Required. List of function overloads, must contain at least one overload.
- Overload::setOverloadId() — Method in class Overload
- Required. Globally unique overload name of the function which reflects the function name and argument types.
- Overload::setParams() — Method in class Overload
- List of function parameter [Type][google.api.expr.v1alpha1.Type] values.
- Overload::setTypeParams() — Method in class Overload
- The type param names associated with the function declaration.
- Overload::setResultType() — Method in class Overload
- Required. The result type of the function. For example, the operator
string.isEmpty()
would haveresult_type
ofkind: BOOL
. - Overload::setIsInstanceFunction() — Method in class Overload
- Whether the function is to be used in a method call-style `x.f(.
- Overload::setDoc() — Method in class Overload
- Documentation string for the overload.
- IdentDecl::setType() — Method in class IdentDecl
- Required. The type of the identifier.
- IdentDecl::setValue() — Method in class IdentDecl
- The constant value of the identifier. If not specified, the identifier must be supplied at evaluation time.
- IdentDecl::setDoc() — Method in class IdentDecl
- Documentation string for the identifier.
- EnumValue::setType() — Method in class EnumValue
- The fully qualified name of the enum type.
- EnumValue::setValue() — Method in class EnumValue
- The value of the enum.
- ErrorSet::setErrors() — Method in class ErrorSet
- The errors in the set.
- EvalRequest::setParsedExpr() — Method in class EvalRequest
- Evaluate based on the parsed representation.
- EvalRequest::setCheckedExpr() — Method in class EvalRequest
- Evaluate based on the checked representation.
- EvalRequest::setBindings() — Method in class EvalRequest
- Bindings for the external variables. The types SHOULD be compatible with the type environment in [CheckRequest][google.api.expr.v1alpha1.CheckRequest], if checked.
- EvalRequest::setContainer() — Method in class EvalRequest
- SHOULD be the same container as used in [CheckRequest][google.api.expr.v1alpha1.CheckRequest], if checked.
- EvalResponse::setResult() — Method in class EvalResponse
- The execution result, or unset if execution couldn't start.
- EvalResponse::setIssues() — Method in class EvalResponse
- Any number of issues with [StatusDetails][] as the details.
- EvalState::setValues() — Method in class EvalState
- The unique values referenced in this message.
- EvalState::setResults() — Method in class EvalState
- An ordered list of results.
- Result::setExpr() — Method in class Result
- The id of the expression this result if for.
- Result::setValue() — Method in class Result
- The index in
values
of the resulting value. - Explain::setValues() — Method in class Explain
- All of the observed values.
- Explain::setExprSteps() — Method in class Explain
- List of steps.
- ExprStep::setId() — Method in class ExprStep
- ID of corresponding Expr node.
- ExprStep::setValueIndex() — Method in class ExprStep
- Index of the value in the values list.
- Expr::setId() — Method in class Expr
- Required. An id assigned to this node by the parser which is unique in a given expression tree. This is used to associate type information and other attributes to a node in the parse tree.
- Expr::setConstExpr() — Method in class Expr
- A literal expression.
- Expr::setIdentExpr() — Method in class Expr
- An identifier expression.
- Expr::setSelectExpr() — Method in class Expr
- A field selection expression, e.g.
request.auth
. - Expr::setCallExpr() — Method in class Expr
- A call expression, including calls to predefined functions and operators.
- Expr::setListExpr() — Method in class Expr
- A list creation expression.
- Expr::setStructExpr() — Method in class Expr
- A map or message creation expression.
- Expr::setComprehensionExpr() — Method in class Expr
- A comprehension expression.
- ExprValue::setValue() — Method in class ExprValue
- A concrete value.
- ExprValue::setError() — Method in class ExprValue
- The set of errors in the critical path of evalution.
- ExprValue::setUnknown() — Method in class ExprValue
- The set of unknowns in the critical path of evaluation.
- Call::setTarget() — Method in class Call
- The target of an method call-style expression. For example,
x
inx.f()
. - Call::setFunction() — Method in class Call
- Required. The name of the function or method being called.
- Call::setArgs() — Method in class Call
- The arguments.
- Comprehension::setIterVar() — Method in class Comprehension
- The name of the iteration variable.
- Comprehension::setIterRange() — Method in class Comprehension
- The range over which var iterates.
- Comprehension::setAccuVar() — Method in class Comprehension
- The name of the variable used for accumulation of the result.
- Comprehension::setAccuInit() — Method in class Comprehension
- The initial value of the accumulator.
- Comprehension::setLoopCondition() — Method in class Comprehension
- An expression which can contain iter_var and accu_var.
- Comprehension::setLoopStep() — Method in class Comprehension
- An expression which can contain iter_var and accu_var.
- Comprehension::setResult() — Method in class Comprehension
- An expression which can contain accu_var.
- CreateList::setElements() — Method in class CreateList
- The elements part of the list.
- CreateStruct::setMessageName() — Method in class CreateStruct
- The type name of the message to be created, empty when creating map literals.
- CreateStruct::setEntries() — Method in class CreateStruct
- The entries in the creation expression.
- Entry::setId() — Method in class Entry
- Required. An id assigned to this node by the parser which is unique in a given expression tree. This is used to associate type information and other attributes to the node.
- Entry::setFieldKey() — Method in class Entry
- The field key for a message creator statement.
- Entry::setMapKey() — Method in class Entry
- The key expression for a map creation statement.
- Entry::setValue() — Method in class Entry
- Required. The value assigned to the key.
- Ident::setName() — Method in class Ident
- Required. Holds a single, unqualified identifier, possibly preceded by a '.'.
- Select — Class in namespace Google\Api\Expr\V1alpha1\Expr
- A field selection expression. e.g.
request.auth
. - Select::setOperand() — Method in class Select
- Required. The target of the selection expression.
- Select::setField() — Method in class Select
- Required. The name of the field to select.
- Select::setTestOnly() — Method in class Select
- Whether the select is to be interpreted as a field presence test.
- IssueDetails::setSeverity() — Method in class IssueDetails
- The severity of the issue.
- IssueDetails::setPosition() — Method in class IssueDetails
- Position in the source, if known.
- IssueDetails::setId() — Method in class IssueDetails
- Expression ID from [Expr][google.api.expr.v1alpha1.Expr], 0 if unknown.
- Severity — Class in namespace Google\Api\Expr\V1alpha1\IssueDetails
- Severities of issues.
- ListValue::setValues() — Method in class ListValue
- The ordered values in the list.
- MapValue::setEntries() — Method in class MapValue
- The set of map entries.
- Entry::setKey() — Method in class Entry
- The key.
- Entry::setValue() — Method in class Entry
- The value.
- ParseRequest::setCelSource() — Method in class ParseRequest
- Required. Source text in CEL syntax.
- ParseRequest::setSyntaxVersion() — Method in class ParseRequest
- Tag for version of CEL syntax, for future use.
- ParseRequest::setSourceLocation() — Method in class ParseRequest
- File or resource for source text, used in [SourceInfo][google.api.expr.v1alpha1.SourceInfo].
- ParseRequest::setDisableMacros() — Method in class ParseRequest
- Prevent macro expansion. See "Macros" in Language Defiinition.
- ParseResponse::setParsedExpr() — Method in class ParseResponse
- The parsed representation, or unset if parsing failed.
- ParseResponse::setIssues() — Method in class ParseResponse
- Any number of issues with [StatusDetails][] as the details.
- ParsedExpr::setExpr() — Method in class ParsedExpr
- The parsed expression.
- ParsedExpr::setSourceInfo() — Method in class ParsedExpr
- The source info derived from input that generated the parsed
expr
. - Reference::setName() — Method in class Reference
- The fully qualified name of the declaration.
- Reference::setOverloadId() — Method in class Reference
- For references to functions, this is a list of
Overload.overload_id
values which match according to typing rules. - Reference::setValue() — Method in class Reference
- For references to constants, this may contain the value of the constant if known at compile time.
- SourceInfo — Class in namespace Google\Api\Expr\V1alpha1
- Source information collected at parse time.
- SourceInfo::setSyntaxVersion() — Method in class SourceInfo
- The syntax version of the source, e.g.
cel1
. - SourceInfo::setLocation() — Method in class SourceInfo
- The location name. All position information attached to an expression is relative to this location.
- SourceInfo::setLineOffsets() — Method in class SourceInfo
- Monotonically increasing list of character offsets where newlines appear.
- SourceInfo::setPositions() — Method in class SourceInfo
- A map from the parse node id (e.g.
Expr.id
) to the character offset within source. - SourceInfo::setMacroCalls() — Method in class SourceInfo
- A map from the parse node id where a macro replacement was made to the
call
Expr
that resulted in a macro expansion. - SourcePosition — Class in namespace Google\Api\Expr\V1alpha1
- A specific position in source.
- SourcePosition::setLocation() — Method in class SourcePosition
- The soucre location name (e.g. file name).
- SourcePosition::setOffset() — Method in class SourcePosition
- The character offset.
- SourcePosition::setLine() — Method in class SourcePosition
- The 1-based index of the starting line in the source text where the issue occurs, or 0 if unknown.
- SourcePosition::setColumn() — Method in class SourcePosition
- The 0-based index of the starting position within the line of source text where the issue occurs. Only meaningful if line is nonzero.
- Type::setDyn() — Method in class Type
- Dynamic type.
- Type::setNull() — Method in class Type
- Null value.
- Type::setPrimitive() — Method in class Type
- Primitive types:
true
,1u
,-2.0
,'string'
,b'bytes'
. - Type::setWrapper() — Method in class Type
- Wrapper of a primitive type, e.g.
google.protobuf.Int64Value
. - Type::setWellKnown() — Method in class Type
- Well-known protobuf type such as
google.protobuf.Timestamp
. - Type::setListType() — Method in class Type
- Parameterized list with elements of
list_type
, e.g.list<timestamp>
. - Type::setMapType() — Method in class Type
- Parameterized map with typed keys and values.
- Type::setFunction() — Method in class Type
- Function type.
- Type::setMessageType() — Method in class Type
- Protocol buffer message type.
- Type::setTypeParam() — Method in class Type
- Type param type.
- Type::setType() — Method in class Type
- Type type.
- Type::setError() — Method in class Type
- Error type.
- Type::setAbstractType() — Method in class Type
- Abstract, application defined type.
- AbstractType::setName() — Method in class AbstractType
- The fully qualified name of this abstract type.
- AbstractType::setParameterTypes() — Method in class AbstractType
- Parameter types for this abstract type.
- FunctionType::setResultType() — Method in class FunctionType
- Result type of the function.
- FunctionType::setArgTypes() — Method in class FunctionType
- Argument types of the function.
- ListType::setElemType() — Method in class ListType
- The element type.
- MapType::setKeyType() — Method in class MapType
- The type of the key.
- MapType::setValueType() — Method in class MapType
- The type of the value.
- UnknownSet::setExprs() — Method in class UnknownSet
- The ids of the expressions with unknown values.
- Value::setNullValue() — Method in class Value
- Null value.
- Value::setBoolValue() — Method in class Value
- Boolean value.
- Value::setInt64Value() — Method in class Value
- Signed integer value.
- Value::setUint64Value() — Method in class Value
- Unsigned integer value.
- Value::setDoubleValue() — Method in class Value
- Floating point value.
- Value::setStringValue() — Method in class Value
- UTF-8 string value.
- Value::setBytesValue() — Method in class Value
- Byte string value.
- Value::setEnumValue() — Method in class Value
- An enum value.
- Value::setObjectValue() — Method in class Value
- The proto message backing an object value.
- Value::setMapValue() — Method in class Value
- Map value.
- Value::setListValue() — Method in class Value
- List value.
- Value::setTypeValue() — Method in class Value
- Type value.
- Decl::setId() — Method in class Decl
- The id of the declaration.
- Decl::setName() — Method in class Decl
- The name of the declaration.
- Decl::setDoc() — Method in class Decl
- The documentation string for the declaration.
- Decl::setIdent() — Method in class Decl
- An identifier declaration.
- Decl::setFunction() — Method in class Decl
- A function declaration.
- DeclType::setId() — Method in class DeclType
- The expression id of the declared type, if applicable.
- DeclType::setType() — Method in class DeclType
- The type name, e.g. 'int', 'my.type.Type' or 'T'
- DeclType::setTypeParams() — Method in class DeclType
- An ordered list of type parameters, e.g.
<string, int>
. - EnumValue::setType() — Method in class EnumValue
- The fully qualified name of the enum type.
- EnumValue::setValue() — Method in class EnumValue
- The value of the enum.
- ErrorSet::setErrors() — Method in class ErrorSet
- The errors in the set.
- EvalState::setValues() — Method in class EvalState
- The unique values referenced in this message.
- EvalState::setResults() — Method in class EvalState
- An ordered list of results.
- Result::setExpr() — Method in class Result
- The expression this result is for.
- Result::setValue() — Method in class Result
- The index in
values
of the resulting value. - Expr::setId() — Method in class Expr
- Required. An id assigned to this node by the parser which is unique in a given expression tree. This is used to associate type information and other attributes to a node in the parse tree.
- Expr::setLiteralExpr() — Method in class Expr
- A literal expression.
- Expr::setIdentExpr() — Method in class Expr
- An identifier expression.
- Expr::setSelectExpr() — Method in class Expr
- A field selection expression, e.g.
request.auth
. - Expr::setCallExpr() — Method in class Expr
- A call expression, including calls to predefined functions and operators.
- Expr::setListExpr() — Method in class Expr
- A list creation expression.
- Expr::setStructExpr() — Method in class Expr
- A map or object creation expression.
- Expr::setComprehensionExpr() — Method in class Expr
- A comprehension expression.
- ExprValue::setValue() — Method in class ExprValue
- A concrete value.
- ExprValue::setError() — Method in class ExprValue
- The set of errors in the critical path of evalution.
- ExprValue::setUnknown() — Method in class ExprValue
- The set of unknowns in the critical path of evaluation.
- Call::setTarget() — Method in class Call
- The target of an method call-style expression. For example,
x
inx.f()
. - Call::setFunction() — Method in class Call
- Required. The name of the function or method being called.
- Call::setArgs() — Method in class Call
- The arguments.
- Comprehension::setIterVar() — Method in class Comprehension
- The name of the iteration variable.
- Comprehension::setIterRange() — Method in class Comprehension
- The range over which var iterates.
- Comprehension::setAccuVar() — Method in class Comprehension
- The name of the variable used for accumulation of the result.
- Comprehension::setAccuInit() — Method in class Comprehension
- The initial value of the accumulator.
- Comprehension::setLoopCondition() — Method in class Comprehension
- An expression which can contain iter_var and accu_var.
- Comprehension::setLoopStep() — Method in class Comprehension
- An expression which can contain iter_var and accu_var.
- Comprehension::setResult() — Method in class Comprehension
- An expression which can contain accu_var.
- CreateList::setElements() — Method in class CreateList
- The elements part of the list.
- CreateStruct::setType() — Method in class CreateStruct
- The type name of the message to be created, empty when creating map literals.
- CreateStruct::setEntries() — Method in class CreateStruct
- The entries in the creation expression.
- Entry::setId() — Method in class Entry
- Required. An id assigned to this node by the parser which is unique in a given expression tree. This is used to associate type information and other attributes to the node.
- Entry::setFieldKey() — Method in class Entry
- The field key for a message creator statement.
- Entry::setMapKey() — Method in class Entry
- The key expression for a map creation statement.
- Entry::setValue() — Method in class Entry
- Required. The value assigned to the key.
- Ident::setName() — Method in class Ident
- Required. Holds a single, unqualified identifier, possibly preceded by a '.'.
- Select — Class in namespace Google\Api\Expr\V1beta1\Expr
- A field selection expression. e.g.
request.auth
. - Select::setOperand() — Method in class Select
- Required. The target of the selection expression.
- Select::setField() — Method in class Select
- Required. The name of the field to select.
- Select::setTestOnly() — Method in class Select
- Whether the select is to be interpreted as a field presence test.
- FunctionDecl::setArgs() — Method in class FunctionDecl
- The function arguments.
- FunctionDecl::setReturnType() — Method in class FunctionDecl
- Optional declared return type.
- FunctionDecl::setReceiverFunction() — Method in class FunctionDecl
- If the first argument of the function is the receiver.
- IdRef::setId() — Method in class IdRef
- The expression id.
- IdentDecl::setType() — Method in class IdentDecl
- Optional type of the identifier.
- IdentDecl::setValue() — Method in class IdentDecl
- Optional value of the identifier.
- ListValue::setValues() — Method in class ListValue
- The ordered values in the list.
- Literal::setNullValue() — Method in class Literal
- null value.
- Literal::setBoolValue() — Method in class Literal
- boolean value.
- Literal::setInt64Value() — Method in class Literal
- int64 value.
- Literal::setUint64Value() — Method in class Literal
- uint64 value.
- Literal::setDoubleValue() — Method in class Literal
- double value.
- Literal::setStringValue() — Method in class Literal
- string value.
- Literal::setBytesValue() — Method in class Literal
- bytes value.
- MapValue::setEntries() — Method in class MapValue
- The set of map entries.
- Entry::setKey() — Method in class Entry
- The key.
- Entry::setValue() — Method in class Entry
- The value.
- ParsedExpr::setExpr() — Method in class ParsedExpr
- The parsed expression.
- ParsedExpr::setSourceInfo() — Method in class ParsedExpr
- The source info derived from input that generated the parsed
expr
. - ParsedExpr::setSyntaxVersion() — Method in class ParsedExpr
- The syntax version of the source, e.g.
cel1
. - SourceInfo — Class in namespace Google\Api\Expr\V1beta1
- Source information collected at parse time.
- SourceInfo::setLocation() — Method in class SourceInfo
- The location name. All position information attached to an expression is relative to this location.
- SourceInfo::setLineOffsets() — Method in class SourceInfo
- Monotonically increasing list of character offsets where newlines appear.
- SourceInfo::setPositions() — Method in class SourceInfo
- A map from the parse node id (e.g.
Expr.id
) to the character offset within source. - SourcePosition — Class in namespace Google\Api\Expr\V1beta1
- A specific position in source.
- SourcePosition::setLocation() — Method in class SourcePosition
- The soucre location name (e.g. file name).
- SourcePosition::setOffset() — Method in class SourcePosition
- The character offset.
- SourcePosition::setLine() — Method in class SourcePosition
- The 1-based index of the starting line in the source text where the issue occurs, or 0 if unknown.
- SourcePosition::setColumn() — Method in class SourcePosition
- The 0-based index of the starting position within the line of source text where the issue occurs. Only meaningful if line is nonzer.
- UnknownSet::setExprs() — Method in class UnknownSet
- The ids of the expressions with unknown values.
- Value::setNullValue() — Method in class Value
- Null value.
- Value::setBoolValue() — Method in class Value
- Boolean value.
- Value::setInt64Value() — Method in class Value
- Signed integer value.
- Value::setUint64Value() — Method in class Value
- Unsigned integer value.
- Value::setDoubleValue() — Method in class Value
- Floating point value.
- Value::setStringValue() — Method in class Value
- UTF-8 string value.
- Value::setBytesValue() — Method in class Value
- Byte string value.
- Value::setEnumValue() — Method in class Value
- An enum value.
- Value::setObjectValue() — Method in class Value
- The proto message backing an object value.
- Value::setMapValue() — Method in class Value
- Map value.
- Value::setListValue() — Method in class Value
- List value.
- Value::setTypeValue() — Method in class Value
- A Type value represented by the fully qualified name of the type.
- Http::setRules() — Method in class Http
- A list of HTTP configuration rules that apply to individual API methods.
- Http::setFullyDecodeReservedExpansion() — Method in class Http
- When set to true, URL path parmeters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded.
- HttpBody::setContentType() — Method in class HttpBody
- The HTTP Content-Type string representing the content type of the body.
- HttpBody::setData() — Method in class HttpBody
- HTTP body binary data.
- HttpBody::setExtensions() — Method in class HttpBody
- Application specific response metadata. Must be set in the first response for streaming APIs.
- HttpRule::setSelector() — Method in class HttpRule
- Selects methods to which this rule applies.
- HttpRule::setGet() — Method in class HttpRule
- Used for listing and getting information about resources.
- HttpRule::setPut() — Method in class HttpRule
- Used for updating a resource.
- HttpRule::setPost() — Method in class HttpRule
- Used for creating a resource.
- HttpRule::setDelete() — Method in class HttpRule
- Used for deleting a resource.
- HttpRule::setPatch() — Method in class HttpRule
- Used for updating a resource.
- HttpRule::setCustom() — Method in class HttpRule
- The custom pattern is used for specifying an HTTP method that is not
included in the
pattern
field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. - HttpRule::setBody() — Method in class HttpRule
- The name of the request field whose value is mapped to the HTTP body, or
*
for mapping all fields not captured by the path pattern to the HTTP body. NOTE: the referred field must not be a repeated field and must be present at the top-level of request message type. - HttpRule::setResponseBody() — Method in class HttpRule
- Optional. The name of the response field whose value is mapped to the HTTP body of response. Other response fields are ignored. When not set, the response message will be used as HTTP body of response.
- HttpRule::setAdditionalBindings() — Method in class HttpRule
- Additional HTTP bindings for the selector. Nested bindings must
not contain an
additional_bindings
field themselves (that is, the nesting may only be one level deep). - LabelDescriptor::setKey() — Method in class LabelDescriptor
- The label key.
- LabelDescriptor::setValueType() — Method in class LabelDescriptor
- The type of data that can be assigned to the label.
- LabelDescriptor::setDescription() — Method in class LabelDescriptor
- A human-readable description for the label.
- LogDescriptor::setName() — Method in class LogDescriptor
- The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].
- LogDescriptor::setLabels() — Method in class LogDescriptor
- The set of labels that are available to describe a specific log entry.
- LogDescriptor::setDescription() — Method in class LogDescriptor
- A human-readable description of this log. This information appears in the documentation and can contain details.
- LogDescriptor::setDisplayName() — Method in class LogDescriptor
- The human-readable name for this log. This information appears on the user interface and should be concise.
- Logging::setProducerDestinations() — Method in class Logging
- Logging configurations for sending logs to the producer project.
- Logging::setConsumerDestinations() — Method in class Logging
- Logging configurations for sending logs to the consumer project.
- LoggingDestination::setMonitoredResource() — Method in class LoggingDestination
- The monitored resource type. The type must be defined in the [Service.monitored_resources][google.api.Service.monitored_resources] section.
- LoggingDestination::setLogs() — Method in class LoggingDestination
- Names of the logs to be sent to this destination. Each name must be defined in the [Service.logs][google.api.Service.logs] section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".
- Metric::setType() — Method in class Metric
- An existing metric type, see [google.api.MetricDescriptor][google.api.MetricDescriptor].
- Metric::setLabels() — Method in class Metric
- The set of label values that uniquely identify this metric. All
labels listed in the
MetricDescriptor
must be assigned values. - MetricDescriptor::setName() — Method in class MetricDescriptor
- The resource name of the metric descriptor.
- MetricDescriptor::setType() — Method in class MetricDescriptor
- The metric type, including its DNS name prefix. The type is not
URL-encoded. All user-defined metric types have the DNS name
custom.googleapis.com
orexternal.googleapis.com
. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" - MetricDescriptor::setLabels() — Method in class MetricDescriptor
- The set of labels that can be used to describe a specific
instance of this metric type. For example, the
appengine.googleapis.com/http/server/response_latencies
metric type has a label for the HTTP response code,response_code
, so you can look at latencies for successful responses or just for responses that failed. - MetricDescriptor::setMetricKind() — Method in class MetricDescriptor
- Whether the metric records instantaneous values, changes to a value, etc.
- MetricDescriptor::setValueType() — Method in class MetricDescriptor
- Whether the measurement is an integer, a floating-point number, etc.
- MetricDescriptor::setUnit() — Method in class MetricDescriptor
- The units in which the metric value is reported. It is only applicable
if the
value_type
isINT64
,DOUBLE
, orDISTRIBUTION
. Theunit
defines the representation of the stored metric values. - MetricDescriptor::setDescription() — Method in class MetricDescriptor
- A detailed description of the metric, which can be used in documentation.
- MetricDescriptor::setDisplayName() — Method in class MetricDescriptor
- A concise name for the metric, which can be displayed in user interfaces.
- MetricDescriptor::setMetadata() — Method in class MetricDescriptor
- Optional. Metadata which can be used to guide usage of the metric.
- MetricDescriptor::setLaunchStage() — Method in class MetricDescriptor
- Optional. The launch stage of the metric definition.
- MetricDescriptorMetadata::setLaunchStage() — Method in class MetricDescriptorMetadata
- Deprecated. Please use the MetricDescriptor.launch_stage instead.
- MetricDescriptorMetadata::setSamplePeriod() — Method in class MetricDescriptorMetadata
- The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.
- MetricDescriptorMetadata::setIngestDelay() — Method in class MetricDescriptorMetadata
- The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.
- MetricRule::setSelector() — Method in class MetricRule
- Selects the methods to which this rule applies.
- MetricRule::setMetricCosts() — Method in class MetricRule
- Metrics to update when the selected methods are called, and the associated cost applied to each metric.
- MonitoredResource::setType() — Method in class MonitoredResource
- Required. The monitored resource type. This field must match
the
type
field of a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] object. For example, the type of a Compute Engine VM instance isgce_instance
. - MonitoredResource::setLabels() — Method in class MonitoredResource
- Required. Values for all of the labels listed in the associated monitored
resource descriptor. For example, Compute Engine VM instances use the
labels
"project_id"
,"instance_id"
, and"zone"
. - MonitoredResourceDescriptor::setName() — Method in class MonitoredResourceDescriptor
- Optional. The resource name of the monitored resource descriptor:
"projects/{project_id}/monitoredResourceDescriptors/{type}"
where {type} is the value of thetype
field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format"monitoredResourceDescriptors/{type}"
. - MonitoredResourceDescriptor::setType() — Method in class MonitoredResourceDescriptor
- Required. The monitored resource type. For example, the type
"cloudsql_database"
represents databases in Google Cloud SQL. - MonitoredResourceDescriptor::setDisplayName() — Method in class MonitoredResourceDescriptor
- Optional. A concise name for the monitored resource type that might be
displayed in user interfaces. It should be a Title Cased Noun Phrase,
without any article or other determiners. For example,
"Google Cloud SQL Database"
. - MonitoredResourceDescriptor::setDescription() — Method in class MonitoredResourceDescriptor
- Optional. A detailed description of the monitored resource type that might be used in documentation.
- MonitoredResourceDescriptor::setLabels() — Method in class MonitoredResourceDescriptor
- Required. A set of labels used to describe instances of this monitored
resource type. For example, an individual Google Cloud SQL database is
identified by values for the labels
"database_id"
and"zone"
. - MonitoredResourceMetadata::setSystemLabels() — Method in class MonitoredResourceMetadata
- Output only. Values for predefined system metadata labels.
- MonitoredResourceMetadata::setUserLabels() — Method in class MonitoredResourceMetadata
- Output only. A map of user-defined metadata labels.
- Monitoring::setProducerDestinations() — Method in class Monitoring
- Monitoring configurations for sending metrics to the producer project.
- Monitoring::setConsumerDestinations() — Method in class Monitoring
- Monitoring configurations for sending metrics to the consumer project.
- MonitoringDestination::setMonitoredResource() — Method in class MonitoringDestination
- The monitored resource type. The type must be defined in [Service.monitored_resources][google.api.Service.monitored_resources] section.
- MonitoringDestination::setMetrics() — Method in class MonitoringDestination
- Names of the metrics to report to this monitoring destination.
- OAuthRequirements::setCanonicalScopes() — Method in class OAuthRequirements
- The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted.
- Page::setName() — Method in class Page
- The name of the page. It will be used as an identity of the page to
generate URI of the page, text of the link to this page in navigation,
etc. The full page name (start from the root page name to this page
concatenated with
.
) can be used as reference to the page in your documentation. For example:pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==)
You can reference
Java
page using Markdown reference link syntax:[Java][Tutorial.Java]
. - Page::setContent() — Method in class Page
- The Markdown content of the page. You can use
(== include {path} ==)
to include content from a Markdown file. - Page::setSubpages() — Method in class Page
- Subpages of this page. The order of subpages specified here will be honored in the generated docset.
- ProjectProperties::setProperties() — Method in class ProjectProperties
- List of per consumer project-specific properties.
- Property::setName() — Method in class Property
- The name of the property (a.k.a key).
- Property::setType() — Method in class Property
- The type of this property.
- Property::setDescription() — Method in class Property
- The description of the property
- Quota::setLimits() — Method in class Quota
- List of
QuotaLimit
definitions for the service. - Quota::setMetricRules() — Method in class Quota
- List of
MetricRule
definitions, each one mapping a selected method to one or more metrics. - QuotaLimit::setName() — Method in class QuotaLimit
- Name of the quota limit. The name is used to refer to the limit when overriding the default limit on per-consumer basis.
- QuotaLimit::setDescription() — Method in class QuotaLimit
- Optional. User-visible, extended description for this quota limit.
- QuotaLimit::setDefaultLimit() — Method in class QuotaLimit
- Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project.
- QuotaLimit::setMaxLimit() — Method in class QuotaLimit
- Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit.
- QuotaLimit::setFreeTier() — Method in class QuotaLimit
- Free tier value displayed in the Developers Console for this limit.
- QuotaLimit::setDuration() — Method in class QuotaLimit
- Duration of this limit in textual notation. Example: "100s", "24h", "1d".
- QuotaLimit::setMetric() — Method in class QuotaLimit
- The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config.
- QuotaLimit::setUnit() — Method in class QuotaLimit
- Specify the unit of the quota limit. It uses the same syntax as [Metric.unit][]. The supported unit kinds are determined by the quota backend system.
- QuotaLimit::setValues() — Method in class QuotaLimit
- Tiered limit values. Also allows for regional or zone overrides for these values if "/{region}" or "/{zone}" is specified in the unit field.
- QuotaLimit::setDisplayName() — Method in class QuotaLimit
- User-visible display name for this limit.
- ResourceDescriptor::setType() — Method in class ResourceDescriptor
- The resource type. It must be in the format of
{service_name}/{resource_type_kind}. The
resource_type_kind
must be singular and must not include version numbers. - ResourceDescriptor::setPattern() — Method in class ResourceDescriptor
- Optional. The relative resource name pattern associated with this resource type. The DNS prefix of the full resource name shouldn't be specified here.
- ResourceDescriptor::setNameField() — Method in class ResourceDescriptor
- Optional. The field on the resource that designates the resource name field. If omitted, this is assumed to be "name".
- ResourceDescriptor::setHistory() — Method in class ResourceDescriptor
- Optional. The historical or future-looking state of the resource pattern.
- ResourceDescriptor::setPlural() — Method in class ResourceDescriptor
- The plural name used in the resource name, such as 'projects' for
the name of 'projects/{project}'. It is the same concept of the
plural
field in k8s CRD spec https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/ - ResourceDescriptor::setSingular() — Method in class ResourceDescriptor
- The same concept of the
singular
field in k8s CRD spec https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/ Such as "project" for theresourcemanager.googleapis.com/Project
type. - ResourceReference::setType() — Method in class ResourceReference
- The resource type that the annotated field references.
- ResourceReference::setChildType() — Method in class ResourceReference
- The resource type of a child collection that the annotated field
references. This is useful for annotating the
parent
field that doesn't have a fixed resource type. - RoutingParameter::setField() — Method in class RoutingParameter
- A request field to extract the header key-value pair from.
- RoutingParameter::setPathTemplate() — Method in class RoutingParameter
- A pattern matching the key-value field. Optional.
- RoutingRule::setRoutingParameters() — Method in class RoutingRule
- A collection of Routing Parameter specifications.
- Service — Class in namespace Google\Api
Service
is the root object of Google service configuration schema. It describes basic information about a service, such as the name and the title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. See each proto message definition for details.- Service::setConfigVersion() — Method in class Service
- The semantic version of the service configuration. The config version affects the interpretation of the service configuration. For example, certain features are enabled by default for certain config versions.
- Service::setConfigVersionUnwrapped() — Method in class Service
- Sets the field by wrapping a primitive type in a Google\Protobuf\UInt32Value object.
- Service::setName() — Method in class Service
- The DNS address at which this service is available,
e.g.
calendar.googleapis.com
. - Service::setId() — Method in class Service
- A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead.
- Service::setTitle() — Method in class Service
- The product title for this service.
- Service::setProducerProjectId() — Method in class Service
- The Google project that owns this service.
- Service::setApis() — Method in class Service
- A list of API interfaces exported by this service. Only the
name
field of the [google.protobuf.Api][google.protobuf.Api] needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. - Service::setTypes() — Method in class Service
- A list of all proto message types included in this API service.
- Service::setEnums() — Method in class Service
- A list of all enum types included in this API service. Enums
referenced directly or indirectly by the
apis
are automatically included. Enums which are not referenced but shall be included should be listed here by name. Example: enums: - name: google.someapi.v1.SomeEnum - Service::setDocumentation() — Method in class Service
- Additional API documentation.
- Service::setBackend() — Method in class Service
- API backend configuration.
- Service::setHttp() — Method in class Service
- HTTP configuration.
- Service::setQuota() — Method in class Service
- Quota configuration.
- Service::setAuthentication() — Method in class Service
- Auth configuration.
- Service::setContext() — Method in class Service
- Context configuration.
- Service::setUsage() — Method in class Service
- Configuration controlling usage of this service.
- Service::setEndpoints() — Method in class Service
- Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.
- Service::setControl() — Method in class Service
- Configuration for the service control plane.
- Service::setLogs() — Method in class Service
- Defines the logs used by this service.
- Service::setMetrics() — Method in class Service
- Defines the metrics used by this service.
- Service::setMonitoredResources() — Method in class Service
- Defines the monitored resources used by this service. This is required by the [Service.monitoring][google.api.Service.monitoring] and [Service.logging][google.api.Service.logging] configurations.
- Service::setBilling() — Method in class Service
- Billing configuration.
- Service::setLogging() — Method in class Service
- Logging configuration.
- Service::setMonitoring() — Method in class Service
- Monitoring configuration.
- Service::setSystemParameters() — Method in class Service
- System parameter configuration.
- Service::setSourceInfo() — Method in class Service
- Output only. The source information for this configuration if available.
- SourceInfo — Class in namespace Google\Api
- Source information used to create a Service Config
- SourceInfo::setSourceFiles() — Method in class SourceInfo
- All files used during config generation.
- SystemParameter — Class in namespace Google\Api
- Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent.
- SystemParameter::setName() — Method in class SystemParameter
- Define the name of the parameter, such as "api_key" . It is case sensitive.
- SystemParameter::setHttpHeader() — Method in class SystemParameter
- Define the HTTP header name to use for the parameter. It is case insensitive.
- SystemParameter::setUrlQueryParameter() — Method in class SystemParameter
- Define the URL query parameter name to use for the parameter. It is case sensitive.
- SystemParameterRule — Class in namespace Google\Api
- Define a system parameter rule mapping system parameter definitions to methods.
- SystemParameterRule::setSelector() — Method in class SystemParameterRule
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs.
- SystemParameterRule::setParameters() — Method in class SystemParameterRule
- Define parameters. Multiple names may be defined for a parameter.
- SystemParameters — Class in namespace Google\Api
System parameter configuration
A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters.
- SystemParameters::setRules() — Method in class SystemParameters
- Define system parameters.
- Usage::setRequirements() — Method in class Usage
- Requirements that must be satisfied before a consumer project can use the
service. Each requirement is of the form <service.name>/
; for example 'serviceusage.googleapis.com/billing-enabled'. - Usage::setRules() — Method in class Usage
- A list of usage rules that apply to individual API methods.
- Usage::setProducerNotificationChannel() — Method in class Usage
- The full resource name of a channel used for sending notifications to the service producer.
- UsageRule::setSelector() — Method in class UsageRule
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs.
- UsageRule::setAllowUnregisteredCalls() — Method in class UsageRule
- If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
- UsageRule::setSkipServiceControl() — Method in class UsageRule
- If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available.
- AuditConfigDelta::setAction() — Method in class AuditConfigDelta
- The action that was performed on an audit configuration in a policy.
- AuditConfigDelta::setService() — Method in class AuditConfigDelta
- Specifies a service that was configured for Cloud Audit Logging.
- AuditConfigDelta::setExemptedMember() — Method in class AuditConfigDelta
- A single identity that is exempted from "data access" audit
logging for the
service
specified above. - AuditConfigDelta::setLogType() — Method in class AuditConfigDelta
- Specifies the log_type that was be enabled. ADMIN_ACTIVITY is always enabled, and cannot be configured.
- Binding::setRole() — Method in class Binding
- Role that is assigned to
members
. - Binding::setMembers() — Method in class Binding
- Specifies the identities requesting access for a Cloud Platform resource.
- Binding::setCondition() — Method in class Binding
- The condition that is associated with this binding.
- BindingDelta::setAction() — Method in class BindingDelta
- The action that was performed on a Binding.
- BindingDelta::setRole() — Method in class BindingDelta
- Role that is assigned to
members
. - BindingDelta::setMember() — Method in class BindingDelta
- A single identity requesting access for a Cloud Platform resource.
- BindingDelta::setCondition() — Method in class BindingDelta
- The condition that is associated with this binding.
- GetIamPolicyRequest::setResource() — Method in class GetIamPolicyRequest
- REQUIRED: The resource for which the policy is being requested.
- GetIamPolicyRequest::setOptions() — Method in class GetIamPolicyRequest
- OPTIONAL: A
GetPolicyOptions
object for specifying options toGetIamPolicy
. This field is only used by Cloud IAM. - GetPolicyOptions::setRequestedPolicyVersion() — Method in class GetPolicyOptions
- Optional. The policy format version to be returned.
- Policy::setVersion() — Method in class Policy
- Specifies the format of the policy.
- Policy::setBindings() — Method in class Policy
- Associates a list of
members
to arole
. Optionally may specify acondition
that determines when binding is in effect. - Policy::setEtag() — Method in class Policy
etag
is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other.- PolicyDelta::setBindingDeltas() — Method in class PolicyDelta
- The delta for Bindings between two policies.
- PolicyDelta::setAuditConfigDeltas() — Method in class PolicyDelta
- The delta for AuditConfigs between two policies.
- SetIamPolicyRequest — Class in namespace Google\Cloud\Iam\V1
- Request message for
SetIamPolicy
method. - SetIamPolicyRequest::setResource() — Method in class SetIamPolicyRequest
- REQUIRED: The resource for which the policy is being specified.
- SetIamPolicyRequest::setPolicy() — Method in class SetIamPolicyRequest
- REQUIRED: The complete policy to be applied to the
resource
. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. - TestIamPermissionsRequest::setResource() — Method in class TestIamPermissionsRequest
- REQUIRED: The resource for which the policy detail is being requested.
- TestIamPermissionsRequest::setPermissions() — Method in class TestIamPermissionsRequest
- The set of permissions to check for the
resource
. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview. - TestIamPermissionsResponse::setPermissions() — Method in class TestIamPermissionsResponse
- A subset of
TestPermissionsRequest.permissions
that the caller is allowed. - GetLocationRequest::setName() — Method in class GetLocationRequest
- Resource name for the location.
- ListLocationsRequest::setName() — Method in class ListLocationsRequest
- The resource that owns the locations collection, if applicable.
- ListLocationsRequest::setFilter() — Method in class ListLocationsRequest
- The standard list filter.
- ListLocationsRequest::setPageSize() — Method in class ListLocationsRequest
- The standard list page size.
- ListLocationsRequest::setPageToken() — Method in class ListLocationsRequest
- The standard list page token.
- ListLocationsResponse::setLocations() — Method in class ListLocationsResponse
- A list of locations that matches the specified filter in the request.
- ListLocationsResponse::setNextPageToken() — Method in class ListLocationsResponse
- The standard List next-page token.
- Location::setName() — Method in class Location
- Resource name for the location, which may vary between implementations.
- Location::setLocationId() — Method in class Location
- The canonical id for this location. For example:
"us-east1"
. - Location::setDisplayName() — Method in class Location
- The friendly name for this location, typically a nearby city name.
- Location::setLabels() — Method in class Location
- Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
- Location::setMetadata() — Method in class Location
- Service-specific metadata. For example the available capacity at the given location.
- HttpRequest::setRequestMethod() — Method in class HttpRequest
- The request method. Examples:
"GET"
,"HEAD"
,"PUT"
,"POST"
. - HttpRequest::setRequestUrl() — Method in class HttpRequest
- The scheme (http, https), the host name, the path and the query portion of the URL that was requested.
- HttpRequest::setRequestSize() — Method in class HttpRequest
- The size of the HTTP request message in bytes, including the request headers and the request body.
- HttpRequest::setStatus() — Method in class HttpRequest
- The response code indicating the status of response.
- HttpRequest::setResponseSize() — Method in class HttpRequest
- The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.
- HttpRequest::setUserAgent() — Method in class HttpRequest
- The user agent sent by the client. Example:
"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"
. - HttpRequest::setRemoteIp() — Method in class HttpRequest
- The IP address (IPv4 or IPv6) of the client that issued the HTTP
request. Examples:
"192.168.1.1"
,"FE80::0202:B3FF:FE1E:8329"
. - HttpRequest::setServerIp() — Method in class HttpRequest
- The IP address (IPv4 or IPv6) of the origin server that the request was sent to.
- HttpRequest::setReferer() — Method in class HttpRequest
- The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions.
- HttpRequest::setLatency() — Method in class HttpRequest
- The request processing latency on the server, from the time the request was received until the response was sent.
- HttpRequest::setCacheLookup() — Method in class HttpRequest
- Whether or not a cache lookup was attempted.
- HttpRequest::setCacheHit() — Method in class HttpRequest
- Whether or not an entity was served from cache (with or without validation).
- HttpRequest::setCacheValidatedWithOriginServer() — Method in class HttpRequest
- Whether or not the response was validated with the origin server before
being served from cache. This field is only meaningful if
cache_hit
is True. - HttpRequest::setCacheFillBytes() — Method in class HttpRequest
- The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.
- HttpRequest::setProtocol() — Method in class HttpRequest
- Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket"
- AuditData::setPolicyDelta() — Method in class AuditData
- Policy delta between the original policy and the newly set policy.
- BadRequest::setFieldViolations() — Method in class BadRequest
- Describes all violations in a client request.
- FieldViolation::setField() — Method in class FieldViolation
- A path leading to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field. E.g., "field_violations.field" would identify this field.
- FieldViolation::setDescription() — Method in class FieldViolation
- A description of why the request element is bad.
- DebugInfo::setStackEntries() — Method in class DebugInfo
- The stack trace entries indicating where the error occurred.
- DebugInfo::setDetail() — Method in class DebugInfo
- Additional debugging information provided by the server.
- ErrorInfo::setReason() — Method in class ErrorInfo
- The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match /[A-Z0-9_]+/.
- ErrorInfo::setDomain() — Method in class ErrorInfo
- The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
- ErrorInfo::setMetadata() — Method in class ErrorInfo
- Additional structured details about this error.
- Help::setLinks() — Method in class Help
- URL(s) pointing to additional information on handling the current error.
- Link::setDescription() — Method in class Link
- Describes what the link offers.
- Link::setUrl() — Method in class Link
- The URL of the link.
- LocalizedMessage::setLocale() — Method in class LocalizedMessage
- The locale used following the specification defined at http://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- LocalizedMessage::setMessage() — Method in class LocalizedMessage
- The localized error message in the above locale.
- PreconditionFailure::setViolations() — Method in class PreconditionFailure
- Describes all precondition violations.
- $Violation#subject — Property in class Violation
- The subject, relative to the type, that failed.
- Violation::setType() — Method in class Violation
- The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, "TOS" for "Terms of Service violation".
- Violation::setSubject() — Method in class Violation
- The subject, relative to the type, that failed.
- Violation::setDescription() — Method in class Violation
- A description of how the precondition failed. Developers can use this description to understand how to fix the failure.
- QuotaFailure::setViolations() — Method in class QuotaFailure
- Describes all quota violations.
- $Violation#subject — Property in class Violation
- The subject on which the quota check failed.
- Violation::setSubject() — Method in class Violation
- The subject on which the quota check failed.
- Violation::setDescription() — Method in class Violation
- A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.
- $RequestInfo#serving_data — Property in class RequestInfo
- Any data that was used to serve this request. For example, an encrypted stack trace that can be sent back to the service provider for debugging.
- RequestInfo::setRequestId() — Method in class RequestInfo
- An opaque string that should only be interpreted by the service generating it. For example, it can be used to identify requests in the service's logs.
- RequestInfo::setServingData() — Method in class RequestInfo
- Any data that was used to serve this request. For example, an encrypted stack trace that can be sent back to the service provider for debugging.
- ResourceInfo::setResourceType() — Method in class ResourceInfo
- A name for the type of resource being accessed, e.g. "sql table", "cloud storage bucket", "file", "Google calendar"; or the type URL of the resource: e.g. "type.googleapis.com/google.pubsub.v1.Topic".
- ResourceInfo::setResourceName() — Method in class ResourceInfo
- The name of the resource being accessed. For example, a shared calendar name: "example.com_4fghdhgsrgh@group.calendar.google.com", if the current error is [google.rpc.Code.PERMISSION_DENIED][google.rpc.Code.PERMISSION_DENIED].
- ResourceInfo::setOwner() — Method in class ResourceInfo
- The owner of the resource (optional).
- ResourceInfo::setDescription() — Method in class ResourceInfo
- Describes what error is encountered when accessing this resource.
- RetryInfo::setRetryDelay() — Method in class RetryInfo
- Clients should wait at least this long between retrying the same request.
- Status — Class in namespace Google\Rpc
- The
Status
type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. EachStatus
message contains three pieces of data: error code, error message, and error details. - Status::setCode() — Method in class Status
- The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
- Status::setMessage() — Method in class Status
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- Status::setDetails() — Method in class Status
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- Color::setRed() — Method in class Color
- The amount of red in the color as a value in the interval [0, 1].
- Color::setGreen() — Method in class Color
- The amount of green in the color as a value in the interval [0, 1].
- Color::setBlue() — Method in class Color
- The amount of blue in the color as a value in the interval [0, 1].
- Color::setAlpha() — Method in class Color
- The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset.
- Color::setAlphaUnwrapped() — Method in class Color
- Sets the field by wrapping a primitive type in a Google\Protobuf\FloatValue object.
- Date::setYear() — Method in class Date
- Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
- Date::setMonth() — Method in class Date
- Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
- Date::setDay() — Method in class Date
- Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.
- DateTime::setYear() — Method in class DateTime
- Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
- DateTime::setMonth() — Method in class DateTime
- Required. Month of year. Must be from 1 to 12.
- DateTime::setDay() — Method in class DateTime
- Required. Day of month. Must be from 1 to 31 and valid for the year and month.
- DateTime::setHours() — Method in class DateTime
- Required. Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
- DateTime::setMinutes() — Method in class DateTime
- Required. Minutes of hour of day. Must be from 0 to 59.
- DateTime::setSeconds() — Method in class DateTime
- Required. Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
- DateTime::setNanos() — Method in class DateTime
- Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
- DateTime::setUtcOffset() — Method in class DateTime
- UTC offset. Must be whole seconds, between -18 hours and +18 hours.
- DateTime::setTimeZone() — Method in class DateTime
- Time zone.
- Decimal::setValue() — Method in class Decimal
- The decimal value, as a string.
- Expr::setExpression() — Method in class Expr
- Textual representation of an expression in Common Expression Language syntax.
- Expr::setTitle() — Method in class Expr
- An 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.
- Expr::setDescription() — Method in class Expr
- An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
- Expr::setLocation() — Method in class Expr
- An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
- Fraction::setNumerator() — Method in class Fraction
- The portion of the denominator in the faction, e.g. 2 in 2/3.
- Fraction::setDenominator() — Method in class Fraction
- The value by which the numerator is divided, e.g. 3 in 2/3. Must be positive.
- $Interval#start_time — Property in class Interval
- Optional. Inclusive start of the interval.
- Interval::setStartTime() — Method in class Interval
- Optional. Inclusive start of the interval.
- Interval::setEndTime() — Method in class Interval
- Optional. Exclusive end of the interval.
- LatLng::setLatitude() — Method in class LatLng
- The latitude in degrees. It must be in the range [-90.0, +90.0].
- LatLng::setLongitude() — Method in class LatLng
- The longitude in degrees. It must be in the range [-180.0, +180.0].
- LocalizedText::setText() — Method in class LocalizedText
- Localized string in the language corresponding to `language_code' below.
- LocalizedText::setLanguageCode() — Method in class LocalizedText
- The text's BCP-47 language code, such as "en-US" or "sr-Latn".
- Money::setCurrencyCode() — Method in class Money
- The 3-letter currency code defined in ISO 4217.
- Money::setUnits() — Method in class Money
- The whole units of the amount.
- Money::setNanos() — Method in class Money
- Number of nano (10^-9) units of the amount.
- PhoneNumber::setE164Number() — Method in class PhoneNumber
- The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123".
- PhoneNumber::setShortCode() — Method in class PhoneNumber
- A short code.
- PhoneNumber::setExtension() — Method in class PhoneNumber
- The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here.
- ShortCode — Class in namespace Google\Type\PhoneNumber
- An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan.").
- ShortCode::setRegionCode() — Method in class ShortCode
- Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB".
- ShortCode::setNumber() — Method in class ShortCode
- Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
- PostalAddress::setRevision() — Method in class PostalAddress
- The schema revision of the
PostalAddress
. This must be set to 0, which is the latest revision. - PostalAddress::setRegionCode() — Method in class PostalAddress
- Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
- PostalAddress::setLanguageCode() — Method in class PostalAddress
- Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents.
- PostalAddress::setPostalCode() — Method in class PostalAddress
- Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
- PostalAddress::setSortingCode() — Method in class PostalAddress
- Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
- PostalAddress::setAdministrativeArea() — Method in class PostalAddress
- Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
- PostalAddress::setLocality() — Method in class PostalAddress
- Optional. Generally refers to the city/town portion of the address.
- PostalAddress::setSublocality() — Method in class PostalAddress
- Optional. Sublocality of the address.
- PostalAddress::setAddressLines() — Method in class PostalAddress
- Unstructured address lines describing the lower levels of an address.
- PostalAddress::setRecipients() — Method in class PostalAddress
- Optional. The recipient at the address.
- PostalAddress::setOrganization() — Method in class PostalAddress
- Optional. The name of the organization at the address.
- Quaternion::setX() — Method in class Quaternion
- The x component.
- Quaternion::setY() — Method in class Quaternion
- The y component.
- Quaternion::setZ() — Method in class Quaternion
- The z component.
- Quaternion::setW() — Method in class Quaternion
- The scalar component.
- TimeOfDay::setHours() — Method in class TimeOfDay
- Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
- TimeOfDay::setMinutes() — Method in class TimeOfDay
- Minutes of hour of day. Must be from 0 to 59.
- TimeOfDay::setSeconds() — Method in class TimeOfDay
- Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
- TimeOfDay::setNanos() — Method in class TimeOfDay
- Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
- TimeZone::setId() — Method in class TimeZone
- IANA Time Zone Database time zone, e.g. "America/New_York".
- TimeZone::setVersion() — Method in class TimeZone
- Optional. IANA Time Zone Database version number, e.g. "2019a".
T
- Type — Class in namespace Google\Api\Expr\V1alpha1
- Represents a CEL type.
- $Type#type_kind — Property in class Type
- Type_AbstractType — Class in namespace Google\Api\Expr\V1alpha1
- This class is deprecated. Use Google\Api\Expr\V1alpha1\Type\AbstractType instead.
- Type_FunctionType — Class in namespace Google\Api\Expr\V1alpha1
- This class is deprecated. Use Google\Api\Expr\V1alpha1\Type\FunctionType instead.
- Type_ListType — Class in namespace Google\Api\Expr\V1alpha1
- This class is deprecated. Use Google\Api\Expr\V1alpha1\Type\ListType instead.
- Type_MapType — Class in namespace Google\Api\Expr\V1alpha1
- This class is deprecated. Use Google\Api\Expr\V1alpha1\Type\MapType instead.
- Type_PrimitiveType — Class in namespace Google\Api\Expr\V1alpha1
- This class is deprecated. Use Google\Api\Expr\V1alpha1\Type\PrimitiveType instead.
- Type_WellKnownType — Class in namespace Google\Api\Expr\V1alpha1
- This class is deprecated. Use Google\Api\Expr\V1alpha1\Type\WellKnownType instead.
- TestIamPermissionsRequest — Class in namespace Google\Cloud\Iam\V1
- Request message for
TestIamPermissions
method. - TestIamPermissionsResponse — Class in namespace Google\Cloud\Iam\V1
- Response message for
TestIamPermissions
method. - $Violation#type — Property in class Violation
- The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, "TOS" for "Terms of Service violation".
- $DateTime#time_offset — Property in class DateTime
- $LocalizedText#text — Property in class LocalizedText
- Localized string in the language corresponding to `language_code' below.
- TimeOfDay — Class in namespace Google\Type
- Represents a time of day. The date and time zone are either not significant
or are specified elsewhere. An API may choose to allow leap seconds. Related
types are [google.type.Date][google.type.Date] and
google.protobuf.Timestamp
. - TimeZone — Class in namespace Google\Type
- Represents a time zone from the IANA Time Zone Database.
U
- UnknownSet — Class in namespace Google\Api\Expr\V1alpha1
- A set of expressions for which the value is unknown.
- UnknownSet — Class in namespace Google\Api\Expr\V1beta1
- A set of expressions for which the value is unknown.
- Usage — Class in namespace Google\Api
- Configuration controlling usage of a service.
- UsageRule — Class in namespace Google\Api
- Usage configuration rules for the service.
- $Link#url — Property in class Link
- The URL of the link.
V
- PathTranslation::value() — Method in class PathTranslation
- ChangeType::value() — Method in class ChangeType
- Severity::value() — Method in class Severity
- PrimitiveType::value() — Method in class PrimitiveType
- WellKnownType::value() — Method in class WellKnownType
- Value — Class in namespace Google\Api\Expr\V1alpha1
- Represents a CEL value.
- Value — Class in namespace Google\Api\Expr\V1beta1
- Represents a CEL value.
- FieldBehavior::value() — Method in class FieldBehavior
- ValueType — Class in namespace Google\Api\LabelDescriptor
- Value types that can be used as label values.
- ValueType::value() — Method in class ValueType
- LaunchStage::value() — Method in class LaunchStage
- MetricKind::value() — Method in class MetricKind
- ValueType — Class in namespace Google\Api\MetricDescriptor
- The value type of a metric.
- ValueType::value() — Method in class ValueType
- PropertyType::value() — Method in class PropertyType
- History::value() — Method in class History
- Action::value() — Method in class Action
- Action::value() — Method in class Action
- LogSeverity::value() — Method in class LogSeverity
- OperationResponseMapping::value() — Method in class OperationResponseMapping
- Code::value() — Method in class Code
- Violation — Class in namespace Google\Rpc\PreconditionFailure
- A message type used to describe a single precondition failure.
- Violation — Class in namespace Google\Rpc\QuotaFailure
- A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.
- CalendarPeriod::value() — Method in class CalendarPeriod
- DayOfWeek::value() — Method in class DayOfWeek
- $Decimal#value — Property in class Decimal
- The decimal value, as a string.
- Month::value() — Method in class Month
W
- WellKnownType — Class in namespace Google\Api\Expr\V1alpha1\Type
- Well-known protobuf types treated with first-class support in CEL.
_
- Advice::__construct() — Method in class Advice
- Constructor.
- AuthProvider::__construct() — Method in class AuthProvider
- Constructor.
- AuthRequirement::__construct() — Method in class AuthRequirement
- Constructor.
- Authentication::__construct() — Method in class Authentication
- Constructor.
- AuthenticationRule::__construct() — Method in class AuthenticationRule
- Constructor.
- Backend::__construct() — Method in class Backend
- Constructor.
- BackendRule::__construct() — Method in class BackendRule
- Constructor.
- Billing::__construct() — Method in class Billing
- Constructor.
- BillingDestination::__construct() — Method in class BillingDestination
- Constructor.
- ConfigChange::__construct() — Method in class ConfigChange
- Constructor.
- Context::__construct() — Method in class Context
- Constructor.
- ContextRule::__construct() — Method in class ContextRule
- Constructor.
- Control::__construct() — Method in class Control
- Constructor.
- CustomHttpPattern::__construct() — Method in class CustomHttpPattern
- Constructor.
- Distribution::__construct() — Method in class Distribution
- Constructor.
- BucketOptions::__construct() — Method in class BucketOptions
- Constructor.
- Explicit::__construct() — Method in class Explicit
- Constructor.
- Exponential::__construct() — Method in class Exponential
- Constructor.
- Linear::__construct() — Method in class Linear
- Constructor.
- Exemplar::__construct() — Method in class Exemplar
- Constructor.
- Range::__construct() — Method in class Range
- Constructor.
- Documentation::__construct() — Method in class Documentation
- Constructor.
- DocumentationRule::__construct() — Method in class DocumentationRule
- Constructor.
- Endpoint::__construct() — Method in class Endpoint
- Constructor.
- CheckRequest::__construct() — Method in class CheckRequest
- Constructor.
- CheckResponse::__construct() — Method in class CheckResponse
- Constructor.
- CheckedExpr::__construct() — Method in class CheckedExpr
- Constructor.
- Constant::__construct() — Method in class Constant
- Constructor.
- Decl::__construct() — Method in class Decl
- Constructor.
- FunctionDecl::__construct() — Method in class FunctionDecl
- Constructor.
- Overload::__construct() — Method in class Overload
- Constructor.
- IdentDecl::__construct() — Method in class IdentDecl
- Constructor.
- EnumValue::__construct() — Method in class EnumValue
- Constructor.
- ErrorSet::__construct() — Method in class ErrorSet
- Constructor.
- EvalRequest::__construct() — Method in class EvalRequest
- Constructor.
- EvalResponse::__construct() — Method in class EvalResponse
- Constructor.
- EvalState::__construct() — Method in class EvalState
- Constructor.
- Result::__construct() — Method in class Result
- Constructor.
- Explain::__construct() — Method in class Explain
- Constructor.
- ExprStep::__construct() — Method in class ExprStep
- Constructor.
- Expr::__construct() — Method in class Expr
- Constructor.
- ExprValue::__construct() — Method in class ExprValue
- Constructor.
- Call::__construct() — Method in class Call
- Constructor.
- Comprehension::__construct() — Method in class Comprehension
- Constructor.
- CreateList::__construct() — Method in class CreateList
- Constructor.
- CreateStruct::__construct() — Method in class CreateStruct
- Constructor.
- Entry::__construct() — Method in class Entry
- Constructor.
- Ident::__construct() — Method in class Ident
- Constructor.
- Select::__construct() — Method in class Select
- Constructor.
- IssueDetails::__construct() — Method in class IssueDetails
- Constructor.
- ListValue::__construct() — Method in class ListValue
- Constructor.
- MapValue::__construct() — Method in class MapValue
- Constructor.
- Entry::__construct() — Method in class Entry
- Constructor.
- ParseRequest::__construct() — Method in class ParseRequest
- Constructor.
- ParseResponse::__construct() — Method in class ParseResponse
- Constructor.
- ParsedExpr::__construct() — Method in class ParsedExpr
- Constructor.
- Reference::__construct() — Method in class Reference
- Constructor.
- SourceInfo::__construct() — Method in class SourceInfo
- Constructor.
- SourcePosition::__construct() — Method in class SourcePosition
- Constructor.
- Type::__construct() — Method in class Type
- Constructor.
- AbstractType::__construct() — Method in class AbstractType
- Constructor.
- FunctionType::__construct() — Method in class FunctionType
- Constructor.
- ListType::__construct() — Method in class ListType
- Constructor.
- MapType::__construct() — Method in class MapType
- Constructor.
- UnknownSet::__construct() — Method in class UnknownSet
- Constructor.
- Value::__construct() — Method in class Value
- Constructor.
- Decl::__construct() — Method in class Decl
- Constructor.
- DeclType::__construct() — Method in class DeclType
- Constructor.
- EnumValue::__construct() — Method in class EnumValue
- Constructor.
- ErrorSet::__construct() — Method in class ErrorSet
- Constructor.
- EvalState::__construct() — Method in class EvalState
- Constructor.
- Result::__construct() — Method in class Result
- Constructor.
- Expr::__construct() — Method in class Expr
- Constructor.
- ExprValue::__construct() — Method in class ExprValue
- Constructor.
- Call::__construct() — Method in class Call
- Constructor.
- Comprehension::__construct() — Method in class Comprehension
- Constructor.
- CreateList::__construct() — Method in class CreateList
- Constructor.
- CreateStruct::__construct() — Method in class CreateStruct
- Constructor.
- Entry::__construct() — Method in class Entry
- Constructor.
- Ident::__construct() — Method in class Ident
- Constructor.
- Select::__construct() — Method in class Select
- Constructor.
- FunctionDecl::__construct() — Method in class FunctionDecl
- Constructor.
- IdRef::__construct() — Method in class IdRef
- Constructor.
- IdentDecl::__construct() — Method in class IdentDecl
- Constructor.
- ListValue::__construct() — Method in class ListValue
- Constructor.
- Literal::__construct() — Method in class Literal
- Constructor.
- MapValue::__construct() — Method in class MapValue
- Constructor.
- Entry::__construct() — Method in class Entry
- Constructor.
- ParsedExpr::__construct() — Method in class ParsedExpr
- Constructor.
- SourceInfo::__construct() — Method in class SourceInfo
- Constructor.
- SourcePosition::__construct() — Method in class SourcePosition
- Constructor.
- UnknownSet::__construct() — Method in class UnknownSet
- Constructor.
- Value::__construct() — Method in class Value
- Constructor.
- Http::__construct() — Method in class Http
- Constructor.
- HttpBody::__construct() — Method in class HttpBody
- Constructor.
- HttpRule::__construct() — Method in class HttpRule
- Constructor.
- LabelDescriptor::__construct() — Method in class LabelDescriptor
- Constructor.
- LogDescriptor::__construct() — Method in class LogDescriptor
- Constructor.
- Logging::__construct() — Method in class Logging
- Constructor.
- LoggingDestination::__construct() — Method in class LoggingDestination
- Constructor.
- Metric::__construct() — Method in class Metric
- Constructor.
- MetricDescriptor::__construct() — Method in class MetricDescriptor
- Constructor.
- MetricDescriptorMetadata::__construct() — Method in class MetricDescriptorMetadata
- Constructor.
- MetricRule::__construct() — Method in class MetricRule
- Constructor.
- MonitoredResource::__construct() — Method in class MonitoredResource
- Constructor.
- MonitoredResourceDescriptor::__construct() — Method in class MonitoredResourceDescriptor
- Constructor.
- MonitoredResourceMetadata::__construct() — Method in class MonitoredResourceMetadata
- Constructor.
- Monitoring::__construct() — Method in class Monitoring
- Constructor.
- MonitoringDestination::__construct() — Method in class MonitoringDestination
- Constructor.
- OAuthRequirements::__construct() — Method in class OAuthRequirements
- Constructor.
- Page::__construct() — Method in class Page
- Constructor.
- ProjectProperties::__construct() — Method in class ProjectProperties
- Constructor.
- Property::__construct() — Method in class Property
- Constructor.
- Quota::__construct() — Method in class Quota
- Constructor.
- QuotaLimit::__construct() — Method in class QuotaLimit
- Constructor.
- ResourceDescriptor::__construct() — Method in class ResourceDescriptor
- Constructor.
- ResourceReference::__construct() — Method in class ResourceReference
- Constructor.
- RoutingParameter::__construct() — Method in class RoutingParameter
- Constructor.
- RoutingRule::__construct() — Method in class RoutingRule
- Constructor.
- Service::__construct() — Method in class Service
- Constructor.
- SourceInfo::__construct() — Method in class SourceInfo
- Constructor.
- SystemParameter::__construct() — Method in class SystemParameter
- Constructor.
- SystemParameterRule::__construct() — Method in class SystemParameterRule
- Constructor.
- SystemParameters::__construct() — Method in class SystemParameters
- Constructor.
- Usage::__construct() — Method in class Usage
- Constructor.
- UsageRule::__construct() — Method in class UsageRule
- Constructor.
- AuditConfigDelta::__construct() — Method in class AuditConfigDelta
- Constructor.
- Binding::__construct() — Method in class Binding
- Constructor.
- BindingDelta::__construct() — Method in class BindingDelta
- Constructor.
- GetIamPolicyRequest::__construct() — Method in class GetIamPolicyRequest
- Constructor.
- GetPolicyOptions::__construct() — Method in class GetPolicyOptions
- Constructor.
- Policy::__construct() — Method in class Policy
- Constructor.
- PolicyDelta::__construct() — Method in class PolicyDelta
- Constructor.
- SetIamPolicyRequest::__construct() — Method in class SetIamPolicyRequest
- Constructor.
- TestIamPermissionsRequest::__construct() — Method in class TestIamPermissionsRequest
- Constructor.
- TestIamPermissionsResponse::__construct() — Method in class TestIamPermissionsResponse
- Constructor.
- GetLocationRequest::__construct() — Method in class GetLocationRequest
- Constructor.
- ListLocationsRequest::__construct() — Method in class ListLocationsRequest
- Constructor.
- ListLocationsResponse::__construct() — Method in class ListLocationsResponse
- Constructor.
- Location::__construct() — Method in class Location
- Constructor.
- HttpRequest::__construct() — Method in class HttpRequest
- Constructor.
- AuditData::__construct() — Method in class AuditData
- Constructor.
- BadRequest::__construct() — Method in class BadRequest
- Constructor.
- FieldViolation::__construct() — Method in class FieldViolation
- Constructor.
- DebugInfo::__construct() — Method in class DebugInfo
- Constructor.
- ErrorInfo::__construct() — Method in class ErrorInfo
- Constructor.
- Help::__construct() — Method in class Help
- Constructor.
- Link::__construct() — Method in class Link
- Constructor.
- LocalizedMessage::__construct() — Method in class LocalizedMessage
- Constructor.
- PreconditionFailure::__construct() — Method in class PreconditionFailure
- Constructor.
- Violation::__construct() — Method in class Violation
- Constructor.
- QuotaFailure::__construct() — Method in class QuotaFailure
- Constructor.
- Violation::__construct() — Method in class Violation
- Constructor.
- RequestInfo::__construct() — Method in class RequestInfo
- Constructor.
- ResourceInfo::__construct() — Method in class ResourceInfo
- Constructor.
- RetryInfo::__construct() — Method in class RetryInfo
- Constructor.
- Status::__construct() — Method in class Status
- Constructor.
- Color::__construct() — Method in class Color
- Constructor.
- Date::__construct() — Method in class Date
- Constructor.
- DateTime::__construct() — Method in class DateTime
- Constructor.
- Decimal::__construct() — Method in class Decimal
- Constructor.
- Expr::__construct() — Method in class Expr
- Constructor.
- Fraction::__construct() — Method in class Fraction
- Constructor.
- Interval::__construct() — Method in class Interval
- Constructor.
- LatLng::__construct() — Method in class LatLng
- Constructor.
- LocalizedText::__construct() — Method in class LocalizedText
- Constructor.
- Money::__construct() — Method in class Money
- Constructor.
- PhoneNumber::__construct() — Method in class PhoneNumber
- Constructor.
- ShortCode::__construct() — Method in class ShortCode
- Constructor.
- PostalAddress::__construct() — Method in class PostalAddress
- Constructor.
- Quaternion::__construct() — Method in class Quaternion
- Constructor.
- TimeOfDay::__construct() — Method in class TimeOfDay
- Constructor.
- TimeZone::__construct() — Method in class TimeZone
- Constructor.