Package com.google.cloud.compute.v1

Class ErrorInfo.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ErrorInfo.Builder>
com.google.cloud.compute.v1.ErrorInfo.Builder
All Implemented Interfaces:
ErrorInfoOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ErrorInfo
public static final class ErrorInfo.Builder extends com.google.protobuf.GeneratedMessage.Builder<ErrorInfo.Builder> implements ErrorInfoOrBuilder
 Describes the cause of the error with structured details.

 Example of an error when contacting the "pubsub.googleapis.com" API when it
 is not enabled:

 { "reason": "API_DISABLED"
 "domain": "googleapis.com"
 "metadata": {
 "resource": "projects/123",
 "service": "pubsub.googleapis.com"
 }
 }

 This response indicates that the pubsub.googleapis.com API is not enabled.

 Example of an error that is returned when attempting to create a Spanner
 instance in a region that is out of stock:

 { "reason": "STOCKOUT"
 "domain": "spanner.googleapis.com",
 "metadata": {
 "availableRegions": "us-central1,us-east2"
 }
 }
Protobuf type google.cloud.compute.v1.ErrorInfo

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<ErrorInfo.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<ErrorInfo.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ErrorInfo.Builder>

    • clear

      public ErrorInfo.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<ErrorInfo.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ErrorInfo.Builder>

    • getDefaultInstanceForType

      public ErrorInfo getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public ErrorInfo build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public ErrorInfo buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public ErrorInfo.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ErrorInfo.Builder>

    • mergeFrom

      public ErrorInfo.Builder mergeFrom(ErrorInfo other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ErrorInfo.Builder>

    • mergeFrom

      public ErrorInfo.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ErrorInfo.Builder>
      Throws:
      IOException

    • hasDomain

      public boolean hasDomain()
       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".
      optional string domain = 284415172;
      Specified by:
      hasDomain in interface ErrorInfoOrBuilder
      Returns:
      Whether the domain field is set.

    • getDomain

      public String getDomain()
       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".
      optional string domain = 284415172;
      Specified by:
      getDomain in interface ErrorInfoOrBuilder
      Returns:
      The domain.

    • getDomainBytes

      public com.google.protobuf.ByteString getDomainBytes()
       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".
      optional string domain = 284415172;
      Specified by:
      getDomainBytes in interface ErrorInfoOrBuilder
      Returns:
      The bytes for domain.

    • setDomain

      public ErrorInfo.Builder setDomain(String value)
       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".
      optional string domain = 284415172;
      Parameters:
      value - The domain to set.
      Returns:
      This builder for chaining.

    • clearDomain

      public ErrorInfo.Builder clearDomain()
       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".
      optional string domain = 284415172;
      Returns:
      This builder for chaining.

    • setDomainBytes

      public ErrorInfo.Builder setDomainBytes(com.google.protobuf.ByteString value)
       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".
      optional string domain = 284415172;
      Parameters:
      value - The bytes for domain to set.
      Returns:
      This builder for chaining.

    • getMetadatasCount

      public int getMetadatasCount()
      Description copied from interface: ErrorInfoOrBuilder
       Additional structured details about this error.

 Keys must match a regular expression of `a-z+` but should
 ideally be lowerCamelCase. Also, they must be limited to 64 characters in
 length. When identifying the current value of an exceeded limit, the units
 should be contained in the key, not the value.  For example, rather than
 `{"instanceLimit": "100/request"}`, should be returned as,
 `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
 instances that can be created in a single (batch) request.
      map<string, string> metadatas = 8514340;
      Specified by:
      getMetadatasCount in interface ErrorInfoOrBuilder

    • containsMetadatas

      public boolean containsMetadatas(String key)
       Additional structured details about this error.

 Keys must match a regular expression of `a-z+` but should
 ideally be lowerCamelCase. Also, they must be limited to 64 characters in
 length. When identifying the current value of an exceeded limit, the units
 should be contained in the key, not the value.  For example, rather than
 `{"instanceLimit": "100/request"}`, should be returned as,
 `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
 instances that can be created in a single (batch) request.
      map<string, string> metadatas = 8514340;
      Specified by:
      containsMetadatas in interface ErrorInfoOrBuilder

    • getMetadatas

      @Deprecated public Map<String,String> getMetadatas()
      Deprecated.
      Use getMetadatasMap() instead.
      Specified by:
      getMetadatas in interface ErrorInfoOrBuilder

    • getMetadatasMap

      public Map<String,String> getMetadatasMap()
       Additional structured details about this error.

 Keys must match a regular expression of `a-z+` but should
 ideally be lowerCamelCase. Also, they must be limited to 64 characters in
 length. When identifying the current value of an exceeded limit, the units
 should be contained in the key, not the value.  For example, rather than
 `{"instanceLimit": "100/request"}`, should be returned as,
 `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
 instances that can be created in a single (batch) request.
      map<string, string> metadatas = 8514340;
      Specified by:
      getMetadatasMap in interface ErrorInfoOrBuilder

    • getMetadatasOrDefault

      public String getMetadatasOrDefault(String key, String defaultValue)
       Additional structured details about this error.

 Keys must match a regular expression of `a-z+` but should
 ideally be lowerCamelCase. Also, they must be limited to 64 characters in
 length. When identifying the current value of an exceeded limit, the units
 should be contained in the key, not the value.  For example, rather than
 `{"instanceLimit": "100/request"}`, should be returned as,
 `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
 instances that can be created in a single (batch) request.
      map<string, string> metadatas = 8514340;
      Specified by:
      getMetadatasOrDefault in interface ErrorInfoOrBuilder

    • getMetadatasOrThrow

      public String getMetadatasOrThrow(String key)
       Additional structured details about this error.

 Keys must match a regular expression of `a-z+` but should
 ideally be lowerCamelCase. Also, they must be limited to 64 characters in
 length. When identifying the current value of an exceeded limit, the units
 should be contained in the key, not the value.  For example, rather than
 `{"instanceLimit": "100/request"}`, should be returned as,
 `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
 instances that can be created in a single (batch) request.
      map<string, string> metadatas = 8514340;
      Specified by:
      getMetadatasOrThrow in interface ErrorInfoOrBuilder

    • clearMetadatas

      public ErrorInfo.Builder clearMetadatas()

    • removeMetadatas

      public ErrorInfo.Builder removeMetadatas(String key)
       Additional structured details about this error.

 Keys must match a regular expression of `a-z+` but should
 ideally be lowerCamelCase. Also, they must be limited to 64 characters in
 length. When identifying the current value of an exceeded limit, the units
 should be contained in the key, not the value.  For example, rather than
 `{"instanceLimit": "100/request"}`, should be returned as,
 `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
 instances that can be created in a single (batch) request.
      map<string, string> metadatas = 8514340;

    • getMutableMetadatas

      @Deprecated public Map<String,String> getMutableMetadatas()
      Deprecated.
      Use alternate mutation accessors instead.

    • putMetadatas

      public ErrorInfo.Builder putMetadatas(String key, String value)
       Additional structured details about this error.

 Keys must match a regular expression of `a-z+` but should
 ideally be lowerCamelCase. Also, they must be limited to 64 characters in
 length. When identifying the current value of an exceeded limit, the units
 should be contained in the key, not the value.  For example, rather than
 `{"instanceLimit": "100/request"}`, should be returned as,
 `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
 instances that can be created in a single (batch) request.
      map<string, string> metadatas = 8514340;

    • putAllMetadatas

      public ErrorInfo.Builder putAllMetadatas(Map<String,String> values)
       Additional structured details about this error.

 Keys must match a regular expression of `a-z+` but should
 ideally be lowerCamelCase. Also, they must be limited to 64 characters in
 length. When identifying the current value of an exceeded limit, the units
 should be contained in the key, not the value.  For example, rather than
 `{"instanceLimit": "100/request"}`, should be returned as,
 `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
 instances that can be created in a single (batch) request.
      map<string, string> metadatas = 8514340;

    • hasReason

      public boolean hasReason()
       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
 regular expression of `A-Z+[A-Z0-9]`, which represents
 UPPER_SNAKE_CASE.
      optional string reason = 138777156;
      Specified by:
      hasReason in interface ErrorInfoOrBuilder
      Returns:
      Whether the reason field is set.

    • getReason

      public String getReason()
       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
 regular expression of `A-Z+[A-Z0-9]`, which represents
 UPPER_SNAKE_CASE.
      optional string reason = 138777156;
      Specified by:
      getReason in interface ErrorInfoOrBuilder
      Returns:
      The reason.

    • getReasonBytes

      public com.google.protobuf.ByteString getReasonBytes()
       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
 regular expression of `A-Z+[A-Z0-9]`, which represents
 UPPER_SNAKE_CASE.
      optional string reason = 138777156;
      Specified by:
      getReasonBytes in interface ErrorInfoOrBuilder
      Returns:
      The bytes for reason.

    • setReason

      public ErrorInfo.Builder setReason(String value)
       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
 regular expression of `A-Z+[A-Z0-9]`, which represents
 UPPER_SNAKE_CASE.
      optional string reason = 138777156;
      Parameters:
      value - The reason to set.
      Returns:
      This builder for chaining.

    • clearReason

      public ErrorInfo.Builder clearReason()
       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
 regular expression of `A-Z+[A-Z0-9]`, which represents
 UPPER_SNAKE_CASE.
      optional string reason = 138777156;
      Returns:
      This builder for chaining.

    • setReasonBytes

      public ErrorInfo.Builder setReasonBytes(com.google.protobuf.ByteString value)
       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
 regular expression of `A-Z+[A-Z0-9]`, which represents
 UPPER_SNAKE_CASE.
      optional string reason = 138777156;
      Parameters:
      value - The bytes for reason to set.
      Returns:
      This builder for chaining.